Structureswift-nio 2.72.0NIOCore

CircularBuffer

An automatically expanding ring buffer implementation backed by a ContiguousArray. Even though this implementation will automatically expand if more elements than initialCapacity are stored, it’s advantageous to prevent expansions from happening frequently. Expansions will always force an allocation and a copy to happen.

CircularBuffer.swift:18

struct CircularBuffer<Element>

Mangled symbol

s7NIOCore14CircularBufferVWhat are these?

FNV24: [2R4RZ]

Citizens in NIOCore

Conformances

protocol BidirectionalCollection<Element>
A collection that supports backward as well as forward traversal.
protocol Collection<Element>
A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CustomStringConvertible
A type with a customized textual representation.
protocol ExpressibleByArrayLiteral
A type that can be initialized using an array literal.
protocol MutableCollection<Element>
A collection that supports subscript assignment.
protocol RandomAccessCollection<Element>
A collection that supports efficient random-access index traversal.
protocol RangeReplaceableCollection<Element>
A collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol Sequence<Element>
A type that provides sequential, iterated access to its elements.

Types

struct Index
An opaque CircularBuffer index.

Typealiases

Type members

init()
Allocates an empty buffer.
init(arrayLiteral: Element...)
init(initialCapacity: Int)
Allocates a buffer that can hold up to initialCapacity elements and initialise an empty ring backed by the buffer. When the ring grows to more than initialCapacity elements the buffer will be expanded.

Instance members

var capacity: Int
The total number of elements that the ring can contain without allocating new storage.
var count: Int
Returns the number of element in the ring.
var description: String
Returns a human readable description of the ring.
var endIndex: Index
The CircularBuffer’s “past the end” position—that is, the position one greater than the last valid subscript argument.
var first: Element?
The first Element of the CircularBuffer (or nil if empty).
var isEmpty: Bool
Returns whether the ring is empty.
var startIndex: Index
The position of the first element in a nonempty CircularBuffer.
subscript(Range<Index>) -> SubSequence
subscript(Index) -> Element
Accesses the element at the specified index.
subscript(offset: Int) -> Element
Return element offset from first element.
func append(Element)
Append an element to the end of the ring buffer.
func distance(from: CircularBuffer<Element>.Index, to: CircularBuffer<Element>.Index) -> Int
func index(Index, offsetBy: Int) -> Index
Returns the index offset by distance from index.
func index(after: Index) -> Index
func index(before: Index) -> Index
Returns the index before index.
func modify<Result>(Index, (inout Element) throws -> Result) rethrows -> Result
Modify the element at index.
func popFirst() -> Element?
Removes and returns the first element of the CircularBuffer.
func popLast() -> Element?
Removes and returns the last element of the CircularBuffer.
func prepend(Element)
Prepend an element to the front of the ring buffer.
func remove(at: Index) -> Element
Removes & returns the item at position from the buffer
func removeAll(keepingCapacity: Bool)
Removes all members from the circular buffer whist keeping the capacity.
func removeFirst() -> Element
Removes and returns the first element of the CircularBuffer.
func removeFirst(Int)
Removes the specified number of elements from the beginning of the CircularBuffer.
func removeLast() -> Element
Removes and returns the last element of the CircularBuffer.
func removeLast(Int)
Removes the specified number of elements from the end of the CircularBuffer.
func removeSubrange(Range<Index>)
Removes the elements in the specified subrange from the circular buffer.
func replaceSubrange<C>(Range<Index>, with: C)
Replaces the specified subrange of elements with the given CircularBuffer.
func reserveCapacity(Int)
Prepares the CircularBuffer to store the specified number of elements.

Show implementation details (4)

Type features

init<S>(S)
Creates a new instance of a collection containing the elements of a sequence.
init(repeating: Self.Element, count: Int)
Creates a new collection containing the specified number of a single, repeated value.
static func + <Other>(lhs: Other, rhs: Self) -> Self
Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(lhs: Self, rhs: Other) -> Self
Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(lhs: Self, rhs: Other) -> Self
Creates a new collection by concatenating the elements of two collections.
static func += <Other>(lhs: inout Self, rhs: Other)
Appends the elements of a sequence to a range-replaceable collection.

Instance features

var indices: DefaultIndices<Self>
The indices that are valid for subscripting the collection, in ascending order.
var last: Self.Element?
The last element of the collection.
var lazy: LazySequence<Self>
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
A value less than or equal to the number of elements in the collection.
subscript<R>(R) -> Self.SubSequence
subscript((UnboundedRange_) -> ()) -> Self.SubSequence
subscript<R>(R) -> Self.SubSequence
Accesses the contiguous subrange of the collection’s elements specified by a range expression.
subscript((UnboundedRange_) -> ()) -> Self.SubSequence
subscript(_offset: Int) -> Element
func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool
Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func append(Self.Element)
Adds an element to the end of the collection.
func append<S>(contentsOf: S)
Adds the elements of a sequence or collection to the end of this collection.
func applying(CollectionDifference<Self.Element>) -> Self?
Applies the given difference to this collection.
func compactMap<ElementOfResult>((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(Self.Element) -> Bool
Returns a Boolean value indicating whether the sequence contains the given element.
func contains<C>(C) -> Bool
Returns a Boolean value indicating whether the collection contains the given sequence.
func contains(where: (Self.Element) throws -> Bool) rethrows -> Bool
Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func difference<C>(from: C) -> CollectionDifference<Self.Element>
Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.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: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence
Returns a subsequence by skipping elements while predicate returns true and returning the remaining elements.
func dropFirst(Int) -> Self.SubSequence
Returns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequence
Returns a subsequence containing all but the specified number of final elements.
func elementsEqual<OtherSequence>(OtherSequence) -> Bool
Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsEqual<OtherSequence>(OtherSequence, by: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool
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((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: (Self.Element) throws -> Bool) rethrows -> Self.Element?
Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of: Self.Element) -> Self.Index?
Returns the first index where the specified value appears in the collection.
func firstIndex(where: (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: C) -> Range<Self.Index>?
Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of: C) -> Range<Self.Index>?
Finds and returns the range of the first occurrence of a given collection within this collection.
func flatMap<SegmentOfResult>((Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element]
Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach((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(inout Self.Index, offsetBy: Int)
Offsets the given index by the specified distance.
func formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Bool
Offsets the given index by the specified distance, or so that it equals the given limiting index.
func formIndex(after: inout Self.Index)
Replaces the given index with its successor.
func formIndex(before: inout Self.Index)
func index(Self.Index, offsetBy: Int, limitedBy: 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 insert(Self.Element, at: Self.Index)
Inserts a new element into the collection at the specified position.
func insert<C>(contentsOf: C, at: Self.Index)
Inserts the elements of a sequence into the collection at the specified position.
func joined() -> FlattenSequence<Self>
Returns the elements of this sequence of sequences, concatenated.
func joined(separator: String) -> String
Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func joined<Separator>(separator: Separator) -> JoinedSequence<Self>
Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
func joined(separator: String) -> String
Returns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func last(where: (Self.Element) throws -> Bool) rethrows -> Self.Element?
Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of: Self.Element) -> Self.Index?
Returns the last index where the specified value appears in the collection.
func lastIndex(where: (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>(OtherSequence) -> Bool
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>(OtherSequence, by: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool
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>((Self.Element) throws -> T) rethrows -> [T]
Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T>((Self.Element) throws -> T) rethrows -> [T]
Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> Self.Element?
Returns the maximum element in the sequence.
func max(by: (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.
func min() -> Self.Element?
Returns the minimum element in the sequence.
func min(by: (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.
func partition(by: (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.
func partition(by: (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.
func popFirst() -> Self.Element?
Removes and returns the first element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
func prefix(Int) -> Self.SubSequence
Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequence
Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequence
Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (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: inout T) -> Self.Element?
Returns a random element of the collection, using the given generator as a source for randomness.
func ranges<C>(of: C) -> [Range<Self.Index>]
Finds and returns the ranges of the all occurrences of a given sequence within the collection.
func reduce<Result>(Result, (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: Result, (inout Result, Self.Element) throws -> ()) rethrows -> Result
Returns the result of combining the elements of the sequence using the given closure.
func remove(at: Self.Index) -> Self.Element
Removes and returns the element at the specified position.
func removeAll(keepingCapacity: Bool)
Removes all elements from the collection.
func removeAll(where: (Self.Element) throws -> Bool) rethrows
Removes all the elements that satisfy the given predicate.
func removeAll(where: (Self.Element) throws -> Bool) rethrows
Removes all the elements that satisfy the given predicate.
func removeFirst() -> Self.Element
Removes and returns the first element of the collection.
func removeFirst() -> Self.Element
Removes and returns the first element of the collection.
func removeFirst() -> Self.Element
Removes and returns the first element of the collection.
func removeFirst(Int)
Removes the specified number of elements from the beginning of the collection.
func removeFirst(Int)
Removes the specified number of elements from the beginning of the collection.
func removeFirst(Int)
Removes the specified number of elements from the beginning of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast(Int)
Removes the given number of elements from the end of the collection.
func removeLast(Int)
Removes the specified number of elements from the end of the collection.
func removeLast(Int)
Removes the specified number of elements from the end of the collection.
func removeSubrange(Range<Self.Index>)
Removes the elements in the specified subrange from the collection.
func removeSubrange<R>(R)
Removes the elements in the specified subrange from the collection.
func replace<C, Replacement>(C, with: Replacement, maxReplacements: Int)
Replaces all occurrences of a target sequence with a given collection
func replaceSubrange<C, R>(R, with: C)
Replaces the specified subrange of elements with the given collection.
func replacing<C, Replacement>(C, with: Replacement, maxReplacements: Int) -> Self
Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func replacing<C, Replacement>(C, with: Replacement, subrange: Range<Self.Index>, maxReplacements: Int) -> Self
Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func reserveCapacity(Int)
Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.
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.
func shuffle()
Shuffles the collection in place.
func shuffle<T>(using: inout T)
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: inout T) -> [Self.Element]
Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sort()
Sorts the collection in place.
func sort(by: (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: (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, omittingEmptySubsequences: Bool, whereSeparator: (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, omittingEmptySubsequences: Bool) -> [ArraySlice<Self.Element>]
Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
func split(separator: Self.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Self.SubSequence]
Returns the longest possible subsequences of the collection, in order, around elements equal to the given element.
func split<C>(separator: C, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Self.SubSequence]
Returns the longest possible subsequences of the collection, in order, around elements equal to the given separator.
func starts<PossiblePrefix>(with: PossiblePrefix) -> Bool
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, by: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool
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(Int) -> Self.SubSequence
Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequence
Returns a subsequence from the specified position to the end of the collection.
func swapAt(Self.Index, Self.Index)
Exchanges the values at the specified indices of the collection.
func trimPrefix<Prefix>(Prefix)
Removes the initial elements that satisfy the given predicate from the start of the sequence.
func trimPrefix<Prefix>(Prefix)
Removes the initial elements that satisfy the given predicate from the start of the sequence.
func trimPrefix(while: (Self.Element) throws -> Bool) throws
func trimPrefix(while: (Self.Element) throws -> Bool) rethrows
func trimmingPrefix<Prefix>(Prefix) -> Self.SubSequence
Returns a new collection of the same type by removing initial elements that satisfy the given predicate from the start.
func trimmingPrefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence
func withContiguousMutableStorageIfAvailable<R>((inout UnsafeMutableBufferPointer<Self.Element>) throws -> R) rethrows -> R?
func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R?