Structure

ChaChaPoly.Nonce

A value used once during a cryptographic operation, and then discarded.

Topics

Creating a Nonce

`init()`

Creates a new random nonce.

`init<D>(data: D)`

Creates a nonce from the given data.

Comparing Nonces

`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: (IndexingIterator<Array<UInt8>>.Element, OtherSequence.Element) -> Bool) -> 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 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: (IndexingIterator<Array<UInt8>>.Element, PossiblePrefix.Element) -> Bool) -> 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 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: (IndexingIterator<Array<UInt8>>.Element, IndexingIterator<Array<UInt8>>.Element) -> Bool) -> Bool`

Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.

Iterating over a Nonce’s Bytes

`func forEach((IndexingIterator<Array<UInt8>>.Element) -> Void)`

Calls the given closure on each element in the sequence in the same order as a `for`-`in` loop.

`func enumerated() -> EnumeratedSequence<ChaChaPoly.Nonce>`

Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.

`var underestimatedCount: Int`

A value less than or equal to the number of elements in the sequence, calculated nondestructively.

Finding Bytes

`func contains(IndexingIterator<Array<UInt8>>.Element) -> Bool`

Returns a Boolean value indicating whether the sequence contains the given element.

`func contains(where: (IndexingIterator<Array<UInt8>>.Element) -> Bool) -> Bool`

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

`func allSatisfy((IndexingIterator<Array<UInt8>>.Element) -> Bool) -> Bool`

Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.

`func min(by: (IndexingIterator<Array<UInt8>>.Element, IndexingIterator<Array<UInt8>>.Element) -> Bool) -> IndexingIterator<Array<UInt8>>.Element?`

Returns the minimum element in the sequence, using the given predicate as the comparison between elements.

`func max(by: (IndexingIterator<Array<UInt8>>.Element, IndexingIterator<Array<UInt8>>.Element) -> Bool) -> IndexingIterator<Array<UInt8>>.Element?`

Returns the maximum element in the sequence, using the given predicate as the comparison between elements.

Selecting Bytes

`func filter((IndexingIterator<Array<UInt8>>.Element) -> Bool) -> [IndexingIterator<Array<UInt8>>.Element]`

Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.

`func prefix(Int) -> PrefixSequence<ChaChaPoly.Nonce>`

Returns a sequence, up to the specified maximum length, containing the initial elements of the sequence.

`func prefix(while: (IndexingIterator<Array<UInt8>>.Element) -> Bool) -> [IndexingIterator<Array<UInt8>>.Element]`

Returns a sequence containing the initial, consecutive elements that satisfy the given predicate.

`func suffix(Int) -> [IndexingIterator<Array<UInt8>>.Element]`

Returns a subsequence, up to the given maximum length, containing the final elements of the sequence.

Transforming a Nonce

`func map<T>((IndexingIterator<Array<UInt8>>.Element) -> T) -> [T]`

Returns an array containing the results of mapping the given closure over the sequence’s elements.

`func flatMap<SegmentOfResult>((IndexingIterator<Array<UInt8>>.Element) -> SegmentOfResult) -> [SegmentOfResult.Element]`

Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.

`func compactMap<ElementOfResult>((IndexingIterator<Array<UInt8>>.Element) -> ElementOfResult?) -> [ElementOfResult]`

Returns an array containing the non-`nil` results of calling the given transformation with each element of this sequence.

`func reduce<Result>(Result, (Result, IndexingIterator<Array<UInt8>>.Element) -> Result) -> Result`

Returns the result of combining the elements of the sequence using the given closure.

`func reduce<Result>(into: Result, (inout Result, IndexingIterator<Array<UInt8>>.Element) -> ()) -> Result`

Returns the result of combining the elements of the sequence using the given closure.

`var lazy: LazySequence<ChaChaPoly.Nonce>`

A sequence containing the same elements as this sequence, but on which some operations, such as `map` and `filter`, are implemented lazily.

Reordering Bytes

`func reversed() -> [IndexingIterator<Array<UInt8>>.Element]`

Returns an array containing the elements of this sequence in reverse order.

`func shuffled<T>(using: inout T) -> [IndexingIterator<Array<UInt8>>.Element]`

Returns the elements of the sequence, shuffled using the given generator as a source for randomness.

Excluding Bytes

`func drop(while: (IndexingIterator<Array<UInt8>>.Element) -> Bool) -> DropWhileSequence<ChaChaPoly.Nonce>`

Returns a sequence by skipping the initial, consecutive elements that satisfy the given predicate.

`func dropFirst(Int) -> DropFirstSequence<ChaChaPoly.Nonce>`

Returns a sequence containing all but the given number of initial elements.

`func dropLast(Int) -> [IndexingIterator<Array<UInt8>>.Element]`

Returns a sequence containing all but the given number of final elements.

Splitting a Nonce

`func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (IndexingIterator<Array<UInt8>>.Element) -> Bool) -> [ArraySlice<IndexingIterator<Array<UInt8>>.Element>]`

Returns the longest possible subsequences of the sequence, in order, that don’t contain elements satisfying the given predicate. Elements that are used to split the sequence are not returned as part of any subsequence.

Accessing Underlying Storage

`func withContiguousStorageIfAvailable<R>((UnsafeBufferPointer<IndexingIterator<Array<UInt8>>.Element>) -> R) -> R?`

Call `body(p)`, where `p` is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, `body` is not called and `nil` is returned.