swift-nio-extras/Sources/NIOExtras/NIOExtrasError.swift
Peter Adams da7c04777b
Docnioextras (#169)
* Improve documentation for NIOExtras

Motivation:

Docs will help users do things correctly.

Modifications:

Add missing comments, improve links.

Result:

Better docc documentation

* Docc in NIOHTTPCompression

* NIOSOCKS docc

* Correct bad symbol

* Minor typo

Co-authored-by: Cory Benfield <lukasa@apple.com>
2022-08-03 01:34:45 -07:00

30 lines
1005 B
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2021 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import NIOCore
/// Base type for errors from NIOExtras
public protocol NIOExtrasError: Equatable, Error { }
/// Errors that are raised in NIOExtras.
public enum NIOExtrasErrors {
/// Error indicating that after an operation some unused bytes are left.
public struct LeftOverBytesError: NIOExtrasError {
public let leftOverBytes: ByteBuffer
}
/// The channel was closed before receiving a response to a request.
public struct ClosedBeforeReceivingResponse: NIOExtrasError {}
}