Structureswift-nio 2.84.0NIOCore
ByteBufferView
A view into a portion of a ByteBuffer.
struct ByteBufferViewA ByteBufferView is useful whenever a Collection where Element == UInt8 representing a portion of a ByteBuffer is needed.
A view into a portion of a ByteBuffer.
struct ByteBufferViewA ByteBufferView is useful whenever a Collection where Element == UInt8 representing a portion of a ByteBuffer is needed.
import NIOCoreThe core abstractions that make up SwiftNIO.
struct ByteBufferByteBuffer stores contiguously allocated raw bytes. It is a random and sequential accessible sequence of zero or more bytes (octets).
struct ByteBufferAllocatorThe preferred allocator for ByteBuffer values. The allocation strategy is opaque but is currently libc’s malloc, realloc and free.
enum EndiannessEndianness refers to the sequential order in which bytes are arranged into larger numerical values when stored in memory or when transmitted over digital links.
final class NIOFileHandleDeprecated. NIOFileHandle is a handle to an open file descriptor.
protocol FileDescriptorstruct FileRegionA FileRegion represent a readable portion usually created to be sent over the network.
typealias NIOPOSIXFileMode = mode_tenum IODataIOData unifies standard SwiftNIO types that are raw bytes of data; currently ByteBuffer and FileRegion.
protocol BidirectionalCollection<Element> : Collection where Self.Indices : BidirectionalCollection, Self.SubSequence : BidirectionalCollectionA collection that supports backward as well as forward traversal.
protocol Collection<Element> : SequenceA sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol MutableCollection<Element> : Collection where Self.SubSequence : MutableCollectionA collection that supports subscript assignment.
protocol RandomAccessCollection<Element> : BidirectionalCollection where Self.Indices : RandomAccessCollection, Self.SubSequence : RandomAccessCollectionA collection that supports efficient random-access index traversal.
protocol RangeReplaceableCollection<Element> : Collection where Self.SubSequence : RangeReplaceableCollectionA collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol SendableA thread-safe type whose values can be shared across arbitrary concurrent contexts without introducing a risk of data races. Values of the type may have no shared mutable state, or they may protect that state with a lock or by forcing it to only be accessed from a specific actor.
protocol Sequence<Element>A type that provides sequential, iterated access to its elements.
init() init(_ buffer: ByteBuffer) Creates a ByteBufferView from the readable bytes of the given buffer.
init(arrayLiteral elements: ByteBufferView.Element...) required by ExpressibleByArrayLiteral
var count: Int { get }var endIndex: ByteBufferView.Index { get }var startIndex: ByteBufferView.Index { get }subscript(range: Range<ByteBufferView.Index>) -> ByteBufferView { get set } subscript(position: ByteBufferView.Index) -> UInt8 { get set } static func == (lhs: ByteBufferView, rhs: ByteBufferView) -> Bool required by Equatable
func _copyContents(initializing ptr: UnsafeMutableBufferPointer<UInt8>) -> (IndexingIterator<ByteBufferView>, UnsafeMutableBufferPointer<UInt8>.Index) func _customContainsEquatableElement(_ element: ByteBufferView.Element) -> Bool? func _customIndexOfEquatableElement(_ element: ByteBufferView.Element) -> ByteBufferView.Index?? func _customLastIndexOfEquatableElement(_ element: ByteBufferView.Element) -> ByteBufferView.Index?? func _failEarlyRangeCheck(_ index: ByteBufferView.Index, bounds: ClosedRange<ByteBufferView.Index>) func _failEarlyRangeCheck(_ index: ByteBufferView.Index, bounds: Range<ByteBufferView.Index>) func _failEarlyRangeCheck(_ range: Range<ByteBufferView.Index>, bounds: Range<ByteBufferView.Index>) mutating func append(_ byte: UInt8) Writes a single byte to the underlying ByteBuffer.
mutating func append<Bytes>(contentsOf bytes: Bytes) where Bytes : Sequence, Bytes.Element == UInt8 Writes a sequence of bytes to the underlying ByteBuffer.
func hash(into hasher: inout Hasher) required by Hashable
func index(after i: ByteBufferView.Index) -> ByteBufferView.Index mutating func replaceSubrange<C>(_ subrange: Range<ByteBufferView.Index>, with newElements: C) where C : Collection, C.Element == UInt8 mutating func reserveCapacity(_ minimumCapacity: Int) Reserves enough space in the underlying ByteBuffer such that this view can store the specified number of bytes without reallocation.
func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<UInt8>) throws -> R) rethrows -> R? func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R typealias Element = UInt8typealias Index = Inttypealias SubSequence = ByteBufferViewinit<S>(_ elements: S) where S : Sequence, Self.Element == S.Element Creates a new instance of a collection containing the elements of a sequence.
init(repeating repeatedValue: Self.Element, count: Int) Creates a new collection containing the specified number of a single, repeated value.
var first: Self.Element? { get }The first element of the collection.
var isEmpty: Bool { get }A Boolean value indicating whether the collection is empty.
var last: Self.Element? { get }The last element of the collection.
var lazy: LazySequence<Self> { get }A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var underestimatedCount: Int { get }A value less than or equal to the number of elements in the collection.
subscript<R>(r: R) -> Self.SubSequence where R : RangeExpression, Self.Index == R.Bound { get set } subscript(x: (UnboundedRange_) -> ()) -> Self.SubSequence { get set } subscript<R>(r: R) -> Self.SubSequence where R : RangeExpression, Self.Index == R.Bound { get } Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript(x: (UnboundedRange_) -> ()) -> Self.SubSequence { get } subscript(subranges: RangeSet<Self.Index>) -> DiscontiguousSlice<Self> { get } Accesses a view of this collection with the elements at the given indices.
subscript(_offset offset: Int) -> Self.Element { get } static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func + <Other>(lhs: Other, rhs: Self) -> Self where Other : Sequence, Self.Element == Other.Element Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(lhs: Self, rhs: Other) -> Self where Other : Sequence, Self.Element == Other.Element Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(lhs: Self, rhs: Other) -> Self where Other : RangeReplaceableCollection, Self.Element == Other.Element Creates a new collection by concatenating the elements of two collections.
static func += <Other>(lhs: inout Self, rhs: Other) where Other : Sequence, Self.Element == Other.Element Appends the elements of a sequence to a range-replaceable collection.
func _index(at offset: Int) -> Self.Index func _offset(of index: Self.Index) -> Int func allSatisfy(_ predicate: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
mutating func append(_ newElement: Self.Element) Adds an element to the end of the collection.
mutating func append<S>(contentsOf newElements: S) where S : Sequence, Self.Element == S.Element Adds the elements of a sequence or collection to the end of this collection.
func applying(_ difference: CollectionDifference<Self.Element>) -> Self? Applies the given difference to this collection.
func compactMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func contains(_ element: Self.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where predicate: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func count<E>(where predicate: (Self.Element) throws(E) -> Bool) throws(E) -> Int where E : Error Returns the number of elements in the sequence that satisfy the given predicate.
func difference<C>(from other: C) -> CollectionDifference<Self.Element> where C : BidirectionalCollection, Self.Element == C.Element Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from other: C, by areEquivalent: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.Element> where C : BidirectionalCollection, Self.Element == C.Element Returns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.
func drop(while predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropFirst(_ k: Int = 1) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(_ k: Int) -> Self.SubSequence Returns a subsequence containing all but the specified number of final elements.
func elementsEqual<OtherSequence>(_ other: OtherSequence) -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsEqual<OtherSequence>(_ other: OtherSequence, by areEquivalent: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.
func enumerated() -> EnumeratedSequence<Self> Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.
func filter(_ isIncluded: (Self.Element) throws -> Bool) rethrows -> Self Returns a new collection of the same type containing, in order, the elements of the original collection that satisfy the given predicate.
func first(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of element: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
func firstIndex(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func firstRange<C>(of other: C) -> Range<Self.Index>? where C : Collection, Self.Element == C.Element Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of other: C) -> Range<Self.Index>? where C : Collection, Self.Element == C.Element Finds and returns the range of the first occurrence of a given collection within this collection.
func flatMap<SegmentOfResult>(_ transform: (Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] where SegmentOfResult : Sequence Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach(_ body: (Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a for-in loop.
func formIndex(_ i: inout Self.Index, offsetBy distance: Int) Offsets the given index by the specified distance.
func formIndex(_ i: inout Self.Index, offsetBy distance: Int, limitedBy limit: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex(after i: inout Self.Index) Replaces the given index with its successor.
func formIndex(before i: inout Self.Index) func index(_ i: Self.Index, offsetBy distance: Int, limitedBy limit: Self.Index) -> Self.Index? Returns an index that is the specified distance from the given index, unless that distance is beyond a given limiting index.
func indices(of element: Self.Element) -> RangeSet<Self.Index> Returns the indices of all the elements that are equal to the given element.
func indices(where predicate: (Self.Element) throws -> Bool) rethrows -> RangeSet<Self.Index> Returns the indices of all the elements that match the given predicate.
mutating func insert(_ newElement: Self.Element, at i: Self.Index) Inserts a new element into the collection at the specified position.
mutating func insert<C>(contentsOf newElements: C, at i: Self.Index) where C : Collection, Self.Element == C.Element Inserts the elements of a sequence into the collection at the specified position.
func last(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of element: Self.Element) -> Self.Index? Returns the last index where the specified value appears in the collection.
func lastIndex(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the index of the last element in the collection that matches the given predicate.
func lexicographicallyPrecedes<OtherSequence>(_ other: OtherSequence) -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.
func lexicographicallyPrecedes<OtherSequence>(_ other: OtherSequence, by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func makeIterator() -> IndexingIterator<Self> Returns an iterator over the elements of the collection.
func map<T, E>(_ transform: (Self.Element) throws(E) -> T) throws(E) -> [T] where E : Error Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T, E>(_ transform: (Self.Element) throws(E) -> T) throws(E) -> [T] where E : Error Returns an array containing the results of mapping the given closure over the sequence’s elements.
@warn_unqualified_access func max() -> Self.Element? Returns the maximum element in the sequence.
@warn_unqualified_access func max(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
@warn_unqualified_access func min() -> Self.Element? Returns the minimum element in the sequence.
@warn_unqualified_access func min(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
@discardableResult mutating func moveSubranges(_ subranges: RangeSet<Self.Index>, to insertionPoint: Self.Index) -> Range<Self.Index> Moves the elements in the given subranges to just before the element at the specified index.
mutating func partition(by belongsInSecondPartition: (Self.Element) throws -> Bool) rethrows -> Self.Index Reorders the elements of the collection such that all the elements that match the given predicate are after all the elements that don’t match.
mutating func partition(by belongsInSecondPartition: (Self.Element) throws -> Bool) rethrows -> Self.Index Reorders the elements of the collection such that all the elements that match the given predicate are after all the elements that don’t match.
mutating func popFirst() -> Self.Element? Removes and returns the first element of the collection.
mutating func popLast() -> Self.Element? Removes and returns the last element of the collection.
mutating func popLast() -> Self.Element? Removes and returns the last element of the collection.
mutating func popLast() -> Self.Element? Removes and returns the last element of the collection.
func prefix(_ maxLength: Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through position: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo end: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until predicate returns false and skipping the remaining elements.
func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using generator: inout T) -> Self.Element? where T : RandomNumberGenerator Returns a random element of the collection, using the given generator as a source for randomness.
func ranges<C>(of other: C) -> [Range<Self.Index>] where C : Collection, Self.Element == C.Element Finds and returns the ranges of the all occurrences of a given sequence within the collection.
func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (Result, Self.Element) throws -> Result) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into initialResult: Result, _ updateAccumulatingResult: (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
@discardableResult mutating func remove(at position: Self.Index) -> Self.Element Removes and returns the element at the specified position.
mutating func removeAll(keepingCapacity keepCapacity: Bool = false) Removes all elements from the collection.
mutating func removeAll(where shouldBeRemoved: (Self.Element) throws -> Bool) rethrows Removes all the elements that satisfy the given predicate.
mutating func removeAll(where shouldBeRemoved: (Self.Element) throws -> Bool) rethrows Removes all the elements that satisfy the given predicate.
@discardableResult mutating func removeFirst() -> Self.Element Removes and returns the first element of the collection.
@discardableResult mutating func removeFirst() -> Self.Element Removes and returns the first element of the collection.
@discardableResult mutating func removeFirst() -> Self.Element Removes and returns the first element of the collection.
mutating func removeFirst(_ k: Int) Removes the specified number of elements from the beginning of the collection.
mutating func removeFirst(_ k: Int) Removes the specified number of elements from the beginning of the collection.
mutating func removeFirst(_ k: Int) Removes the specified number of elements from the beginning of the collection.
@discardableResult mutating func removeLast() -> Self.Element Removes and returns the last element of the collection.
@discardableResult mutating func removeLast() -> Self.Element Removes and returns the last element of the collection.
@discardableResult mutating func removeLast() -> Self.Element Removes and returns the last element of the collection.
mutating func removeLast(_ k: Int) Removes the given number of elements from the end of the collection.
mutating func removeLast(_ k: Int) Removes the specified number of elements from the end of the collection.
mutating func removeLast(_ k: Int) Removes the specified number of elements from the end of the collection.
mutating func removeSubrange(_ bounds: Range<Self.Index>) Removes the elements in the specified subrange from the collection.
mutating func removeSubrange<R>(_ bounds: R) where R : RangeExpression, Self.Index == R.Bound Removes the elements in the specified subrange from the collection.
mutating func removeSubranges(_ subranges: RangeSet<Self.Index>) Removes the elements at the given indices.
mutating func removeSubranges(_ subranges: RangeSet<Self.Index>) Removes the elements at the given indices.
func removingSubranges(_ subranges: RangeSet<Self.Index>) -> DiscontiguousSlice<Self> Returns a collection of the elements in this collection that are not represented by the given range set.
mutating func replace<C, Replacement>(_ other: C, with replacement: Replacement, maxReplacements: Int = .max) where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Replaces all occurrences of a target sequence with a given collection
mutating func replaceSubrange<C, R>(_ subrange: R, with newElements: C) where C : Collection, R : RangeExpression, Self.Element == C.Element, Self.Index == R.Bound Replaces the specified subrange of elements with the given collection.
func replacing<C, Replacement>(_ other: C, with replacement: Replacement, maxReplacements: Int = .max) -> Self where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func replacing<C, Replacement>(_ other: C, with replacement: Replacement, subrange: Range<Self.Index>, maxReplacements: Int = .max) -> Self where C : Collection, Replacement : Collection, Self.Element == C.Element, C.Element == Replacement.Element Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
mutating func reserveCapacity(_ n: Int) Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.
mutating func reverse() Reverses the elements of the collection in place.
func reversed() -> ReversedCollection<Self> Returns a view presenting the elements of the collection in reverse order.
mutating func shuffle() Shuffles the collection in place.
mutating func shuffle<T>(using generator: inout T) where T : RandomNumberGenerator Shuffles the collection in place, using the given generator as a source for randomness.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using generator: inout T) -> [Self.Element] where T : RandomNumberGenerator Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
mutating func sort() Sorts the collection in place.
mutating func sort(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows Sorts the collection in place, using the given predicate as the comparison between elements.
func sorted() -> [Self.Element] Returns the elements of the sequence, sorted.
func sorted(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxSplits: Int = Int.max, omittingEmptySubsequences: Bool = true, whereSeparator isSeparator: (Self.Element) throws -> Bool) rethrows -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: Self.Element, maxSplits: Int = Int.max, omittingEmptySubsequences: Bool = true) -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix) -> Bool where PossiblePrefix : Sequence, Self.Element == PossiblePrefix.Element Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
func starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.
func suffix(_ maxLength: Int) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from start: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
mutating func swapAt(_ i: Self.Index, _ j: Self.Index) Exchanges the values at the specified indices of the collection.
mutating func trimPrefix<Prefix>(_ prefix: Prefix) where Prefix : Sequence, Self.Element == Prefix.Element Removes prefix from the start of the collection.
mutating func trimPrefix<Prefix>(_ prefix: Prefix) where Prefix : Sequence, Self.Element == Prefix.Element Removes prefix from the start of the collection.
mutating func trimPrefix(while predicate: (Self.Element) throws -> Bool) throws mutating func trimPrefix(while predicate: (Self.Element) throws -> Bool) rethrows func trimmingPrefix<Prefix>(_ prefix: Prefix) -> Self.SubSequence where Prefix : Sequence, Self.Element == Prefix.Element Returns a new collection of the same type by removing prefix from the start of the collection.
func trimmingPrefix(while predicate: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence mutating func withContiguousMutableStorageIfAvailable<R>(_ body: (inout UnsafeMutableBufferPointer<Self.Element>) throws -> R) rethrows -> R? func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R? func flatMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] func index(of element: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
import NIOFoundationCompatvar regions: CollectionOfOne<ByteBufferView> { get }typealias Regions = CollectionOfOne<ByteBufferView>