Files
swift-nio-http2/Sources/NIOHTTP2/HTTP2Error.swift
T
Peter Adams 1118370ec4 Apply swift-format changes and CI (#472)
Motivation:

Standardised formatting makes the project cleaner to look at and work
on.

Modifications:

Setup swift-format with the same settings as Swift-NIO

Result:

Common formatting throughout
2024-10-29 13:09:54 +00:00

2063 lines
70 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2022 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 NIOHPACK
/// The base protocol for all errors thrown by ``NIOHTTP2``.
///
/// Users are recommended not to implement this protocol with their own types.
public protocol NIOHTTP2Error: Equatable, Error {}
/// An internal marker-protocol for errors to do with content-length.
protocol InvalidContentLengthError: NIOHTTP2Error {}
/// Errors that ``NIOHTTP2`` raises when handling HTTP/2 connections.
public enum NIOHTTP2Errors {
/// Creates an ``ExcessiveOutboundFrameBuffering`` error with appropriate source context.
public static func excessiveOutboundFrameBuffering(
file: String = #fileID,
line: UInt = #line
) -> ExcessiveOutboundFrameBuffering {
ExcessiveOutboundFrameBuffering(file: file, line: line)
}
/// Creates an ``InvalidALPNToken`` error with appropriate source context
public static func invalidALPNToken(file: String = #fileID, line: UInt = #line) -> InvalidALPNToken {
InvalidALPNToken(file: file, line: line)
}
/// Creates a ``NoSuchStream`` error with appropriate source context.
///
/// - Parameters:
/// - streamID: The ``HTTP2StreamID`` for the stream that does not exist.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func noSuchStream(streamID: HTTP2StreamID, file: String = #fileID, line: UInt = #line) -> NoSuchStream
{
NoSuchStream(streamID: streamID, file: file, line: line)
}
/// Creates a ``StreamClosed`` error with appropriate source context.
///
/// - Parameters:
/// - streamID: The ``HTTP2StreamID`` for the stream that is or has been closed
/// - errorCode: The ``HTTP2ErrorCode`` representing the reason for closure of the stream.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func streamClosed(
streamID: HTTP2StreamID,
errorCode: HTTP2ErrorCode,
file: String = #fileID,
line: UInt = #line
) -> StreamClosed {
StreamClosed(streamID: streamID, errorCode: errorCode, file: file, line: line)
}
/// Creates a ``BadClientMagic`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func badClientMagic(file: String = #fileID, line: UInt = #line) -> BadClientMagic {
BadClientMagic(file: file, line: line)
}
/// Creates a ``BadStreamStateTransition`` error with appropriate source context
///
/// - Parameters:
/// - state: The ``NIOHTTP2StreamState`` representing the state of the stream from which we were trying to transition
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func badStreamStateTransition(
from state: NIOHTTP2StreamState? = nil,
file: String = #fileID,
line: UInt = #line
) -> BadStreamStateTransition {
BadStreamStateTransition(from: state, file: file, line: line)
}
/// Creates an ``InvalidFlowControlWindowSize`` error with appropriate source context.
///
/// - Parameters:
/// - delta: The change in the window size that was proposed in error
/// - currentWindowSize: The current size of the stream flow control window
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidFlowControlWindowSize(
delta: Int,
currentWindowSize: Int,
file: String = #fileID,
line: UInt = #line
) -> InvalidFlowControlWindowSize {
InvalidFlowControlWindowSize(delta: delta, currentWindowSize: currentWindowSize, file: file, line: line)
}
/// Creates a ``FlowControlViolation`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func flowControlViolation(file: String = #fileID, line: UInt = #line) -> FlowControlViolation {
FlowControlViolation(file: file, line: line)
}
/// Creates an ``InvalidSetting`` error with appropriate source context.
///
/// - Parameters:
/// - setting: The invalid setting in question
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidSetting(
setting: HTTP2Setting,
file: String = #fileID,
line: UInt = #line
) -> InvalidSetting {
InvalidSetting(setting: setting, file: file, line: line)
}
/// Creates an ``IOOnClosedConnection`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func ioOnClosedConnection(file: String = #fileID, line: UInt = #line) -> IOOnClosedConnection {
IOOnClosedConnection(file: file, line: line)
}
/// Creates a ``ReceivedBadSettings`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func receivedBadSettings(file: String = #fileID, line: UInt = #line) -> ReceivedBadSettings {
ReceivedBadSettings(file: file, line: line)
}
/// Creates a ``MaxStreamsViolation`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func maxStreamsViolation(file: String = #fileID, line: UInt = #line) -> MaxStreamsViolation {
MaxStreamsViolation(file: file, line: line)
}
/// Creates a ``StreamIDTooSmall`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func streamIDTooSmall(file: String = #fileID, line: UInt = #line) -> StreamIDTooSmall {
StreamIDTooSmall(file: file, line: line)
}
/// Creates a ``MissingPreface`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func missingPreface(file: String = #fileID, line: UInt = #line) -> MissingPreface {
MissingPreface(file: file, line: line)
}
/// Creates a ``CreatedStreamAfterGoaway`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func createdStreamAfterGoaway(file: String = #fileID, line: UInt = #line) -> CreatedStreamAfterGoaway
{
CreatedStreamAfterGoaway(file: file, line: line)
}
/// Creates a ``InvalidStreamIDForPeer`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidStreamIDForPeer(file: String = #fileID, line: UInt = #line) -> InvalidStreamIDForPeer {
InvalidStreamIDForPeer(file: file, line: line)
}
/// Creates a ``RaisedGoawayLastStreamID`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func raisedGoawayLastStreamID(file: String = #fileID, line: UInt = #line) -> RaisedGoawayLastStreamID
{
RaisedGoawayLastStreamID(file: file, line: line)
}
/// Creates a ``InvalidWindowIncrementSize`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidWindowIncrementSize(
file: String = #fileID,
line: UInt = #line
) -> InvalidWindowIncrementSize {
InvalidWindowIncrementSize(file: file, line: line)
}
/// Creates a ``PushInViolationOfSetting`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func pushInViolationOfSetting(file: String = #fileID, line: UInt = #line) -> PushInViolationOfSetting
{
PushInViolationOfSetting(file: file, line: line)
}
/// Creates a ``Unsupported`` error with appropriate source context.
///
/// - Parameters:
/// - info: Human-readable information describing _what_ is unsupported.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func unsupported(info: String, file: String = #fileID, line: UInt = #line) -> Unsupported {
Unsupported(info: info, file: file, line: line)
}
/// Creates a ``UnableToSerializeFrame`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func unableToSerializeFrame(file: String = #fileID, line: UInt = #line) -> UnableToSerializeFrame {
UnableToSerializeFrame(file: file, line: line)
}
/// Creates a ``UnableToParseFrame`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func unableToParseFrame(file: String = #fileID, line: UInt = #line) -> UnableToParseFrame {
UnableToParseFrame(file: file, line: line)
}
/// Creates a ``MissingPseudoHeader`` error with appropriate source context.
///
/// - Parameters:
/// - name: The name of the pseudo-header that was missing from the header block.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func missingPseudoHeader(
_ name: String,
file: String = #fileID,
line: UInt = #line
) -> MissingPseudoHeader {
MissingPseudoHeader(name, file: file, line: line)
}
/// Creates a ``DuplicatePseudoHeader`` error with appropriate source context.
///
/// - Parameters:
/// - name: The name of the pseudo-header that was duplicated within the header block.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func duplicatePseudoHeader(
_ name: String,
file: String = #fileID,
line: UInt = #line
) -> DuplicatePseudoHeader {
DuplicatePseudoHeader(name, file: file, line: line)
}
/// Creates a ``PseudoHeaderAfterRegularHeader`` error with appropriate source context.
///
/// - Parameters:
/// - name: The name of the pseudo-header that appeared after a regular header in the header block.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func pseudoHeaderAfterRegularHeader(
_ name: String,
file: String = #fileID,
line: UInt = #line
) -> PseudoHeaderAfterRegularHeader {
PseudoHeaderAfterRegularHeader(name, file: file, line: line)
}
/// Creates a ``UnknownPseudoHeader`` error with appropriate source context.
///
/// - Parameters:
/// - name: The name of the pseudo-header that was not recognised by ``NIOHTTP2``.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func unknownPseudoHeader(
_ name: String,
file: String = #fileID,
line: UInt = #line
) -> UnknownPseudoHeader {
UnknownPseudoHeader(name, file: file, line: line)
}
/// Creates a ``UnsupportedPseudoHeader`` with with appropriate source context.
///
/// - Parameters:
/// - name: The name of the pseudo-header that was not supported by ``NIOHTTP2``.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func unsupportedPseudoHeader(
_ name: String,
file: String = #fileID,
line: UInt = #line
) -> UnsupportedPseudoHeader {
UnsupportedPseudoHeader(name, file: file, line: line)
}
/// Creates a ``InvalidPseudoHeaders`` error with appropriate source context.
///
/// - Parameters:
/// - block: The block of `HPACKHeaders` that contain the invalid pseudo headers.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidPseudoHeaders(
_ block: HPACKHeaders,
file: String = #fileID,
line: UInt = #line
) -> InvalidPseudoHeaders {
InvalidPseudoHeaders(block, file: file, line: line)
}
/// Creates a ``MissingHostHeader`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func missingHostHeader(file: String = #fileID, line: UInt = #line) -> MissingHostHeader {
MissingHostHeader(file: file, line: line)
}
/// Creates a ``DuplicateHostHeader`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func duplicateHostHeader(file: String = #fileID, line: UInt = #line) -> DuplicateHostHeader {
DuplicateHostHeader(file: file, line: line)
}
/// Creates a ``EmptyPathHeader`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func emptyPathHeader(file: String = #fileID, line: UInt = #line) -> EmptyPathHeader {
EmptyPathHeader(file: file, line: line)
}
/// Creates a ``InvalidStatusValue`` error with appropriate source context.
///
/// - Parameters:
/// - value: The value of the `:status` header that is invalid.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidStatusValue(
_ value: String,
file: String = #fileID,
line: UInt = #line
) -> InvalidStatusValue {
InvalidStatusValue(value, file: file, line: line)
}
/// Creates a ``PriorityCycle`` error with appropriate source context.
///
/// - Parameters:
/// - streamID: The ``HTTP2StreamID`` representing the stream that created the priority cycle.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func priorityCycle(
streamID: HTTP2StreamID,
file: String = #fileID,
line: UInt = #line
) -> PriorityCycle {
PriorityCycle(streamID: streamID, file: file, line: line)
}
/// Creates a ``TrailersWithoutEndStream`` error with appropriate source context.
///
/// - Parameters:
/// - streamID: The ``HTTP2StreamID`` on which the `HEADERS` frame without `END_STREAM` was received.
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func trailersWithoutEndStream(
streamID: HTTP2StreamID,
file: String = #fileID,
line: UInt = #line
) -> TrailersWithoutEndStream {
TrailersWithoutEndStream(streamID: streamID, file: file, line: line)
}
/// Creates a ``InvalidHTTP2HeaderFieldName`` error with appropriate source context.
///
/// - Parameters:
/// - fieldName: The invalid HTTP/2 header field name
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func invalidHTTP2HeaderFieldName(
_ fieldName: String,
file: String = #fileID,
line: UInt = #line
) -> InvalidHTTP2HeaderFieldName {
InvalidHTTP2HeaderFieldName(fieldName, file: file, line: line)
}
/// Creates a ``ForbiddenHeaderField`` error with appropriate source context.
///
/// - Parameters:
/// - name: The field name for the forbidden header field
/// - value: The field value for the forbidden header field
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func forbiddenHeaderField(
name: String,
value: String,
file: String = #fileID,
line: UInt = #line
) -> ForbiddenHeaderField {
ForbiddenHeaderField(name: name, value: value, file: file, line: line)
}
/// Creates a ``ContentLengthViolated`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func contentLengthViolated(file: String = #fileID, line: UInt = #line) -> ContentLengthViolated {
ContentLengthViolated(file: file, line: line)
}
/// Creates a ``ContentLengthHeadersMismatch`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func contentLengthHeadersMismatch(
file: String = #fileID,
line: UInt = #line
) -> ContentLengthHeadersMismatch {
ContentLengthHeadersMismatch(file: file, line: line)
}
/// Creates a ``ContentLengthHeaderNegative`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func contentLengthHeaderNegative(
file: String = #fileID,
line: UInt = #line
) -> ContentLengthHeaderNegative {
ContentLengthHeaderNegative(file: file, line: line)
}
/// Creates a ``ContentLengthHeaderMalformedValue`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func contentLengthHeaderMalformedValue(
file: String = #fileID,
line: UInt = #line
) -> ContentLengthHeaderMalformedValue {
ContentLengthHeaderMalformedValue(file: file, line: line)
}
/// Creates a ``ExcessiveEmptyDataFrames`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func excessiveEmptyDataFrames(file: String = #fileID, line: UInt = #line) -> ExcessiveEmptyDataFrames
{
ExcessiveEmptyDataFrames(file: file, line: line)
}
/// Creates a ``ExcessivelyLargeHeaderBlock`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func excessivelyLargeHeaderBlock(
file: String = #fileID,
line: UInt = #line
) -> ExcessivelyLargeHeaderBlock {
ExcessivelyLargeHeaderBlock(file: file, line: line)
}
/// Creates a ``NoStreamIDAvailable`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func noStreamIDAvailable(file: String = #fileID, line: UInt = #line) -> NoStreamIDAvailable {
NoStreamIDAvailable(file: file, line: line)
}
/// Creates a ``MissingMultiplexer`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func missingMultiplexer(file: String = #fileID, line: UInt = #line) -> MissingMultiplexer {
MissingMultiplexer(file: file, line: line)
}
/// Creates a ``ExcessiveRSTFrames`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func excessiveRSTFrames(file: String = #fileID, line: UInt = #line) -> ExcessiveRSTFrames {
ExcessiveRSTFrames(file: file, line: line)
}
/// Creates an ``ExcessiveContinuationFrames`` error with appropriate source context.
///
/// - Parameters:
/// - file: Source file of the caller.
/// - line: Source line number of the caller.
public static func excessiveContinuationFrames(
file: String = #fileID,
line: UInt = #line
) -> ExcessiveContinuationFrames {
ExcessiveContinuationFrames(file: file, line: line)
}
/// Creates a ``StreamError`` error with appropriate source context.
///
/// - Parameters:
/// - streamID: The ``HTTP2StreamID`` on which this error was triggered
/// - baseError: The underlying `Error` that was thrown.
public static func streamError(streamID: HTTP2StreamID, baseError: Error) -> StreamError {
StreamError(streamID: streamID, baseError: baseError)
}
/// The outbound frame buffers have become filled, and it is not possible to buffer
/// further outbound frames. This occurs when the remote peer is generating work
/// faster than they are consuming the result. Additional buffering runs the risk of
/// memory exhaustion.
public struct ExcessiveOutboundFrameBuffering: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "excessiveOutboundFrameBuffering")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ExcessiveOutboundFrameBuffering, rhs: ExcessiveOutboundFrameBuffering) -> Bool {
true
}
}
/// NIO's upgrade handler encountered a successful upgrade to a protocol that it
/// does not recognise.
public struct InvalidALPNToken: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "invalidALPNToken")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: InvalidALPNToken, rhs: InvalidALPNToken) -> Bool {
true
}
}
/// An attempt was made to issue a write on a stream that does not exist.
public struct NoSuchStream: NIOHTTP2Error {
/// The ``HTTP2StreamID`` that was used that does not exist.
public var streamID: HTTP2StreamID
/// The location where the error was thrown.
public let location: String
@available(*, deprecated, renamed: "noSuchStream")
public init(streamID: HTTP2StreamID) {
self.init(streamID: streamID, file: #fileID, line: #line)
}
fileprivate init(streamID: HTTP2StreamID, file: String, line: UInt) {
self.streamID = streamID
self.location = _location(file: file, line: line)
}
public static func == (lhs: NoSuchStream, rhs: NoSuchStream) -> Bool {
lhs.streamID == rhs.streamID
}
}
/// A stream was closed.
public struct StreamClosed: NIOHTTP2Error {
/// The ``HTTP2StreamID`` that was closed.
public var streamID: HTTP2StreamID
/// The ``HTTP2ErrorCode`` associated with the closure.
public var errorCode: HTTP2ErrorCode
/// The file and line where the error was created.
public let location: String
@available(*, deprecated, renamed: "streamClosed")
public init(streamID: HTTP2StreamID, errorCode: HTTP2ErrorCode) {
self.init(streamID: streamID, errorCode: errorCode, file: #fileID, line: #line)
}
fileprivate init(streamID: HTTP2StreamID, errorCode: HTTP2ErrorCode, file: String, line: UInt) {
self.streamID = streamID
self.errorCode = errorCode
self.location = _location(file: file, line: line)
}
public static func == (lhs: StreamClosed, rhs: StreamClosed) -> Bool {
lhs.streamID == rhs.streamID && lhs.errorCode == rhs.errorCode
}
}
/// The expected "client magic" string that must be received first on a HTTP/2 connection was incorrect.
public struct BadClientMagic: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "badClientMagic")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: BadClientMagic, rhs: BadClientMagic) -> Bool {
true
}
}
/// A stream state transition was attempted that was not valid.
public struct BadStreamStateTransition: NIOHTTP2Error, CustomStringConvertible {
/// The ``NIOHTTP2StreamState`` that we were trying to transition out of.
public let fromState: NIOHTTP2StreamState?
/// The location where the error was thrown.
public let location: String
public var description: String {
let stateName = self.fromState != nil ? "\(self.fromState!)" : "unknown state"
return "BadStreamStateTransition(fromState: \(stateName), location: \(self.location))"
}
fileprivate init(from state: NIOHTTP2StreamState?, file: String, line: UInt) {
self.fromState = state
self.location = _location(file: file, line: line)
}
@available(*, deprecated, renamed: "badStreamStateTransition")
public init() {
self.init(from: nil, file: #fileID, line: #line)
}
public static func == (lhs: BadStreamStateTransition, rhs: BadStreamStateTransition) -> Bool {
lhs.fromState == rhs.fromState
}
}
/// An attempt was made to change the flow control window size, either via
/// `SETTINGS` or `WINDOW_UPDATE`, but this change would move the flow control
/// window size out of bounds.
public struct InvalidFlowControlWindowSize: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: Storage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
private final class Storage: Equatable {
var delta: Int
var currentWindowSize: Int
var file: String
var line: UInt
var location: String {
_location(file: self.file, line: self.line)
}
init(delta: Int, currentWindowSize: Int, file: String, line: UInt) {
self.delta = delta
self.currentWindowSize = currentWindowSize
self.file = file
self.line = line
}
func copy() -> Storage {
Storage(delta: self.delta, currentWindowSize: self.currentWindowSize, file: self.file, line: self.line)
}
static func == (lhs: Storage, rhs: Storage) -> Bool {
lhs.delta == rhs.delta && lhs.currentWindowSize == rhs.currentWindowSize
}
}
/// The delta being applied to the flow control window.
public var delta: Int {
get {
self.storage.delta
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.delta = newValue
}
}
/// The size of the flow control window before the delta was applied.
public var currentWindowSize: Int {
get {
self.storage.currentWindowSize
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.currentWindowSize = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"InvalidFlowControlWindowSize(delta: \(self.delta), currentWindowSize: \(self.currentWindowSize), location: \(self.location))"
}
@available(*, deprecated, renamed: "invalidFlowControlWindowSize")
public init(delta: Int, currentWindowSize: Int) {
self.init(delta: delta, currentWindowSize: currentWindowSize, file: #fileID, line: #line)
}
fileprivate init(delta: Int, currentWindowSize: Int, file: String, line: UInt) {
self.storage = Storage(delta: delta, currentWindowSize: currentWindowSize, file: file, line: line)
}
}
/// A frame was sent or received that violates HTTP/2 flow control rules.
public struct FlowControlViolation: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "flowControlViolation")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: FlowControlViolation, rhs: FlowControlViolation) -> Bool {
true
}
}
/// A `SETTINGS` frame was sent or received with an invalid setting.
public struct InvalidSetting: NIOHTTP2Error {
/// The invalid setting.
public var setting: HTTP2Setting
/// The location where the error was thrown.
public let location: String
@available(*, deprecated, renamed: "invalidSetting")
public init(setting: HTTP2Setting) {
self.init(setting: setting, file: #fileID, line: #line)
}
fileprivate init(setting: HTTP2Setting, file: String, line: UInt) {
self.setting = setting
self.location = _location(file: file, line: line)
}
public static func == (lhs: InvalidSetting, rhs: InvalidSetting) -> Bool {
lhs.setting == rhs.setting
}
}
/// An attempt to perform I/O was made on a connection that is already closed.
public struct IOOnClosedConnection: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "ioOnClosedConnection")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: IOOnClosedConnection, rhs: IOOnClosedConnection) -> Bool {
true
}
}
/// A `SETTINGS` frame was received that is invalid.
public struct ReceivedBadSettings: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "receivedBadSettings")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ReceivedBadSettings, rhs: ReceivedBadSettings) -> Bool {
true
}
}
/// A violation of `SETTINGS_MAX_CONCURRENT_STREAMS` occurred.
public struct MaxStreamsViolation: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "maxStreamsViolation")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: MaxStreamsViolation, rhs: MaxStreamsViolation) -> Bool {
true
}
}
/// An attempt was made to use a stream ID that is too small.
public struct StreamIDTooSmall: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "streamIDTooSmall")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: StreamIDTooSmall, rhs: StreamIDTooSmall) -> Bool {
true
}
}
/// An attempt was made to send a frame without having previously sent a connection preface!
public struct MissingPreface: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "missingPreface")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: MissingPreface, rhs: MissingPreface) -> Bool {
true
}
}
/// An attempt was made to create a stream after a `GOAWAY` frame has forbidden further
/// stream creation.
public struct CreatedStreamAfterGoaway: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "createdStreamAfterGoaway")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: CreatedStreamAfterGoaway, rhs: CreatedStreamAfterGoaway) -> Bool {
true
}
}
/// A peer has attempted to create a stream with a stream ID it is not permitted to use.
public struct InvalidStreamIDForPeer: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "invalidStreamIDForPeer")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: InvalidStreamIDForPeer, rhs: InvalidStreamIDForPeer) -> Bool {
true
}
}
/// An attempt was made to send a new `GOAWAY` frame whose `lastStreamID` is higher than the previous value.
public struct RaisedGoawayLastStreamID: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "raisedGoawayLastStreamID")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: RaisedGoawayLastStreamID, rhs: RaisedGoawayLastStreamID) -> Bool {
true
}
}
/// The size of the window increment is invalid.
public struct InvalidWindowIncrementSize: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "invalidWindowIncrementSize")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: InvalidWindowIncrementSize, rhs: InvalidWindowIncrementSize) -> Bool {
true
}
}
/// An attempt was made to push a stream, even though the settings forbid it.
public struct PushInViolationOfSetting: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "pushInViolationOfSetting")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: PushInViolationOfSetting, rhs: PushInViolationOfSetting) -> Bool {
true
}
}
/// An attempt was made to use a currently unsupported feature.
public struct Unsupported: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// A human-readable description of what unsupported feature was used.
public var info: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"Unsupported(info: \(self.info), location: \(self.location))"
}
@available(*, deprecated, renamed: "unsupported")
public init(info: String) {
self.init(info: info, file: #fileID, line: #line)
}
fileprivate init(info: String, file: String, line: UInt) {
self.storage = .init(info, file: file, line: line)
}
}
/// A HTTP/2 frame could not be serialized.
public struct UnableToSerializeFrame: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "unableToSerializeFrame")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: UnableToSerializeFrame, rhs: UnableToSerializeFrame) -> Bool {
true
}
}
/// A HTTP/2 frame was unable to be parsed.
public struct UnableToParseFrame: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "unableToParseFrame")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: UnableToParseFrame, rhs: UnableToParseFrame) -> Bool {
true
}
}
/// A pseudo-header field is missing.
public struct MissingPseudoHeader: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the missing pseudo-header field
public var name: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"MissingPseudoHeader(name: \(self.name), location: \(self.location))"
}
@available(*, deprecated, renamed: "missingPseudoHeader")
public init(_ name: String) {
self.init(name, file: #fileID, line: #line)
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// A pseudo-header field has been duplicated.
public struct DuplicatePseudoHeader: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the pseudo-header field that was duplicated
public var name: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"DuplicatePseudoHeader(name: \(self.name), location: \(self.location))"
}
@available(*, deprecated, renamed: "duplicatePseudoHeader")
public init(_ name: String) {
self.init(name, file: #fileID, line: #line)
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// A header block contained a pseudo-header after a regular header.
public struct PseudoHeaderAfterRegularHeader: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the pseudo-header that occurred after the regular header.
public var name: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"PseudoHeaderAfterRegularHeader(name: \(self.name), location: \(self.location))"
}
@available(*, deprecated, renamed: "pseudoHeaderAfterRegularHeader")
public init(_ name: String) {
self.init(name, file: #fileID, line: #line)
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// An unknown pseudo-header was received.
public struct UnknownPseudoHeader: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the unrecognised pseudo-header field.
public var name: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"UnknownPseudoHeader(name: \(self.name), location: \(self.location))"
}
@available(*, deprecated, renamed: "unknownPseudoHeader")
public init(_ name: String) {
self.init(name, file: #fileID, line: #line)
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// An unsupported pseudo-header was received.
public struct UnsupportedPseudoHeader: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the unsupported pseudo-header field.
public var name: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"UnsupportedPseudoHeader(name: \(self.name), location: \(self.location))"
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// A header block was received with an invalid set of pseudo-headers for the block type.
public struct InvalidPseudoHeaders: NIOHTTP2Error {
/// The header block containing the invalid set of pseudo-headers.
public var headerBlock: HPACKHeaders
/// The location where the error was thrown.
public let location: String
@available(*, deprecated, renamed: "invalidPseudoHeaders")
public init(_ block: HPACKHeaders) {
self.init(block, file: #fileID, line: #line)
}
fileprivate init(_ block: HPACKHeaders, file: String, line: UInt) {
self.headerBlock = block
self.location = _location(file: file, line: line)
}
public static func == (lhs: InvalidPseudoHeaders, rhs: InvalidPseudoHeaders) -> Bool {
lhs.headerBlock == rhs.headerBlock
}
}
/// An outbound request was about to be sent, but does not contain a Host header.
public struct MissingHostHeader: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "missingHostHeader")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: MissingHostHeader, rhs: MissingHostHeader) -> Bool {
true
}
}
/// An outbound request was about to be sent, but it contains a duplicated Host header.
public struct DuplicateHostHeader: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "duplicateHostHeader")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: DuplicateHostHeader, rhs: DuplicateHostHeader) -> Bool {
true
}
}
/// A HTTP/2 header block was received with an empty :path header.
public struct EmptyPathHeader: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "emptyPathHeader")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: EmptyPathHeader, rhs: EmptyPathHeader) -> Bool {
true
}
}
/// A `:status` header was received with an invalid value.
public struct InvalidStatusValue: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The invalid value of the `:status` header.
public var value: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"InvalidStatusValue(value: \(self.value), location: \(self.location))"
}
@available(*, deprecated, renamed: "invalidStatusValue")
public init(_ value: String) {
self.init(value, file: #fileID, line: #line)
}
fileprivate init(_ value: String, file: String, line: UInt) {
self.storage = .init(value, file: file, line: line)
}
}
/// A priority update was received that would create a `PRIORITY` cycle.
public struct PriorityCycle: NIOHTTP2Error {
/// The affected stream ID.
public var streamID: HTTP2StreamID
/// The location where the error was thrown.
public let location: String
@available(*, deprecated, renamed: "priorityCycle")
public init(streamID: HTTP2StreamID) {
self.init(streamID: streamID, file: #fileID, line: #line)
}
fileprivate init(streamID: HTTP2StreamID, file: String, line: UInt) {
self.streamID = streamID
self.location = _location(file: file, line: line)
}
public static func == (lhs: PriorityCycle, rhs: PriorityCycle) -> Bool {
lhs.streamID == rhs.streamID
}
}
/// An attempt was made to send trailers without setting `END_STREAM` on them.
public struct TrailersWithoutEndStream: NIOHTTP2Error {
/// The affected stream ID.
public var streamID: HTTP2StreamID
/// The location where the error was thrown.
public let location: String
@available(*, deprecated, renamed: "trailersWithoutEndStream")
public init(streamID: HTTP2StreamID) {
self.init(streamID: streamID, file: #fileID, line: #line)
}
fileprivate init(streamID: HTTP2StreamID, file: String, line: UInt) {
self.streamID = streamID
self.location = _location(file: file, line: line)
}
public static func == (lhs: TrailersWithoutEndStream, rhs: TrailersWithoutEndStream) -> Bool {
lhs.streamID == rhs.streamID
}
}
/// An attempt was made to send a header field with a field name that is not valid in HTTP/2.
public struct InvalidHTTP2HeaderFieldName: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: StringAndLocationStorage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The name of the invalid header field.
public var fieldName: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"InvalidHTTP2HeaderFieldName(fieldName: \(self.fieldName), location: \(self.location))"
}
@available(*, deprecated, renamed: "invalidHTTP2HeaderFieldName")
public init(_ name: String) {
self.init(name, file: #fileID, line: #line)
}
fileprivate init(_ name: String, file: String, line: UInt) {
self.storage = .init(name, file: file, line: line)
}
}
/// Connection-specific header fields are forbidden in HTTP/2: this error is raised when one is
/// sent or received.
public struct ForbiddenHeaderField: NIOHTTP2Error, CustomStringConvertible, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private var storage: Storage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
private final class Storage: Equatable {
var name: String
var value: String
var file: String
var line: UInt
var location: String {
_location(file: self.file, line: self.line)
}
init(name: String, value: String, file: String, line: UInt) {
self.name = name
self.value = value
self.file = file
self.line = line
}
func copy() -> Storage {
Storage(name: self.name, value: self.value, file: self.file, line: self.line)
}
static func == (lhs: Storage, rhs: Storage) -> Bool {
lhs.name == rhs.name && lhs.value == rhs.value
}
}
/// The name of the forbidden header field.
public var name: String {
get {
self.storage.name
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.name = newValue
}
}
/// The value of the forbidden header field.
public var value: String {
get {
self.storage.value
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.value = newValue
}
}
/// The file and line where the error was created.
public var location: String {
get {
self.storage.location
}
}
public var description: String {
"ForbiddenHeaderField(name: \(self.name), value: \(self.value), location: \(self.location))"
}
@available(*, deprecated, renamed: "forbiddenHeaderField")
public init(name: String, value: String) {
self.init(name: name, value: value, file: #fileID, line: #line)
}
fileprivate init(name: String, value: String, file: String, line: UInt) {
self.storage = Storage(name: name, value: value, file: file, line: line)
}
}
/// A request or response has violated the expected content length, either exceeding or falling beneath it.
public struct ContentLengthViolated: NIOHTTP2Error, InvalidContentLengthError {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "contentLengthViolated")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ContentLengthViolated, rhs: ContentLengthViolated) -> Bool {
true
}
}
/// A request header block contains multiple content length headers with disagreeing values
public struct ContentLengthHeadersMismatch: NIOHTTP2Error, InvalidContentLengthError {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ContentLengthHeadersMismatch, rhs: ContentLengthHeadersMismatch) -> Bool {
true
}
}
/// A request header block contains a content length header with a negative value
public struct ContentLengthHeaderNegative: NIOHTTP2Error, InvalidContentLengthError {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ContentLengthHeaderNegative, rhs: ContentLengthHeaderNegative) -> Bool {
true
}
}
/// A request header block contains a content length header with a malformed value
/// e.g. an unparsable string or an integer which cannot be represented by an Int
public struct ContentLengthHeaderMalformedValue: NIOHTTP2Error, InvalidContentLengthError {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ContentLengthHeaderMalformedValue, rhs: ContentLengthHeaderMalformedValue) -> Bool {
true
}
}
/// The remote peer has sent an excessive number of empty `DATA` frames, which looks like a denial of service
/// attempt, so the connection has been closed.
public struct ExcessiveEmptyDataFrames: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "excessiveEmptyDataFrames")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ExcessiveEmptyDataFrames, rhs: ExcessiveEmptyDataFrames) -> Bool {
true
}
}
/// The remote peer has sent a header block so large that ``NIOHTTP2`` refuses to buffer any more data than that.
public struct ExcessivelyLargeHeaderBlock: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "excessivelyLargeHeaderBlock")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: ExcessivelyLargeHeaderBlock, rhs: ExcessivelyLargeHeaderBlock) -> Bool {
true
}
}
/// The channel does not yet have a stream ID, as it has not reached the network yet.
public struct NoStreamIDAvailable: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
@available(*, deprecated, renamed: "noStreamIDAvailable")
public init() {
self.init(file: #fileID, line: #line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: NoStreamIDAvailable, rhs: NoStreamIDAvailable) -> Bool {
true
}
}
/// A StreamError was hit during outbound frame processing.
///
/// Stream errors are wrappers around another error of some other kind that occurred on a specific stream.
/// As they are a wrapper error, they carry a "real" error in ``baseError``. Additionally, they cannot
/// meaningfully be `Equatable`, so they aren't. There's also no additional location information: that's
/// provided by the base error.
public struct StreamError: Error, @unchecked Sendable {
// @unchecked Sendable because access is controlled by getters and copy-on-write setters giving this value semantics
private final class Storage {
var streamID: HTTP2StreamID
var baseError: Error
init(streamID: HTTP2StreamID, baseError: Error) {
self.baseError = baseError
self.streamID = streamID
}
func copy() -> Storage {
Storage(
streamID: self.streamID,
baseError: self.baseError
)
}
}
private var storage: Storage
private mutating func copyStorageIfNotUniquelyReferenced() {
if !isKnownUniquelyReferenced(&self.storage) {
self.storage = self.storage.copy()
}
}
/// The underlying thrown error.
public var baseError: Error {
get {
self.storage.baseError
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.baseError = newValue
}
}
/// The ``HTTP2StreamID`` on which the error was thrown.
public var streamID: HTTP2StreamID {
get {
self.storage.streamID
}
set {
self.copyStorageIfNotUniquelyReferenced()
self.storage.streamID = newValue
}
}
public var description: String {
"StreamError(streamID: \(self.streamID), baseError: \(self.baseError))"
}
fileprivate init(streamID: HTTP2StreamID, baseError: Error) {
self.storage = .init(streamID: streamID, baseError: baseError)
}
}
public struct ActivationError: NIOHTTP2Error, CustomStringConvertible {
private let state: NIOHTTP2Handler.ActivationState
private var activating: Bool
init(state: NIOHTTP2Handler.ActivationState, activating: Bool) {
self.state = state
self.activating = activating
}
public var description: String {
if self.activating {
return "Error during activation: in state \(self.state)"
} else {
return "Error during inactivation: in state \(self.state)"
}
}
}
/// The ``NIOHTTP2Handler`` does not have a multiplexer but one has been accessed.
public struct MissingMultiplexer: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: Self, rhs: Self) -> Bool {
true
}
}
/// The client has issued RST frames at an excessive rate resulting in the connection being defensively closed.
public struct ExcessiveRSTFrames: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: Self, rhs: Self) -> Bool {
true
}
}
/// A remote peer has sent a sequence of `CONTINUATION` frames longer than the configured limit.
public struct ExcessiveContinuationFrames: NIOHTTP2Error {
private let file: String
private let line: UInt
/// The location where the error was thrown.
public var location: String {
_location(file: self.file, line: self.line)
}
fileprivate init(file: String, line: UInt) {
self.file = file
self.line = line
}
public static func == (lhs: Self, rhs: Self) -> Bool {
true
}
}
}
/// This enum covers errors that are thrown internally for messaging reasons. These should
/// not leak.
internal enum InternalError: Error {
case attemptedToCreateStream
case codecError(code: HTTP2ErrorCode)
// Used to record that an impossible situation occured. Crashes in debug mode, errors in
// release mode.
static func impossibleSituation(file: StaticString = #fileID, line: UInt = #line) -> InternalError {
assertionFailure(file: file, line: line)
return .codecError(code: .internalError)
}
}
extension InternalError: Hashable {}
private func _location(file: String, line: UInt) -> String {
"\(file):\(line)"
}
private final class StringAndLocationStorage: Equatable {
var value: String
var file: String
var line: UInt
var location: String {
_location(file: self.file, line: self.line)
}
init(_ value: String, file: String, line: UInt) {
self.value = value
self.file = file
self.line = line
}
func copy() -> StringAndLocationStorage {
StringAndLocationStorage(self.value, file: self.file, line: self.line)
}
static func == (lhs: StringAndLocationStorage, rhs: StringAndLocationStorage) -> Bool {
// Only compare the value. The 'file' is not relevant here.
lhs.value == rhs.value
}
}