A MongoDB object reference. This type models a MongoDB ObjectId.
@frozen struct IdentifierThis type has reference semantics, but (needless to say) it is completely unmanaged, as it is nothing more than a 96-bit integer.
The type name is chosen to avoid conflict with Swift’s ObjectIdentifier.
import BSONABIModels the BSON type system and the binary interface of the BSON serialization format.
@frozen enum BSONThe namespace for all BSON types.
@frozen struct ObjectIdentifierA unique identifier for a class instance or metatype.
@frozen struct MinThe MongoDB min-key. This type has a single state, and is isomorphic to Void. It is mainly used by the decoding and encoding layers as an API landmark.
@frozen struct MaxThe MongoDB max-key. This type has a single state, and is isomorphic to Void. It is mainly used by the decoding and encoding layers as an API landmark.
@frozen struct Decimal128An opaque IEEE 754-2008 decimal.
@frozen struct RegexA MongoDB regex.
@frozen struct UnixMillisecondA low-precision instant in time, measured in milliseconds since the Unix epoch.
protocol BufferFrame : BSON.BufferFrameTypeA type that augments a BufferFrameType conformance with a BSON metatype value. This is a derived protocol because it is sometimes useful to repurpose the BSON frame parsing machinery for additional (fictional) frame types that never appear in BSON data.
protocol BufferFrameTypeA type that specifies the layout of a variable-length BSON view. Parsers use conforming types to decide how to interpret BSON length headers read from input data.
protocol BufferTraversableA framed type that BSON parsers can traverse in constant time.
protocol Decoderprotocol Encoder<Frame>protocol OutputStream@frozen enum AnyTypeA BSON metatype. The raw value of this enumeration is the type code of the associated case in BSON’s ABI.
@frozen enum AnyValueAny BSON value.
@frozen struct BinaryBuffer<Element> where Element : BitwiseCopyableA BinaryBuffer is a typed view of an ArraySlice as a densely-packed buffer of trivial Elements. It’s a good idea to use something unpretentious like a tuple of fixed-width integers for the Element type, to avoid unexpected padding behavior.
@frozen enum BinaryFrameSpecifies the interpretation of a length header attached to a binary array.
@frozen struct BinarySubtypeA BSON binary metatype. This type’s public API performs canonicalization and therefore instances of this type are safe to compare.
@frozen struct BinarySubtypeErrorThe subtype byte of a binary array matched a reserved bit pattern.
@frozen struct BinaryView<Bytes> where Bytes : RandomAccessCollection, Bytes.Element == UInt8A BSON binary array.
@frozen struct BinaryViewErrorA binary view was sliced from a malformed storage buffer.
@frozen struct BooleanSubtypeErrorA byte encoding a boolean value was not 0 or 1.
@frozen struct DocumentThe Document type models the “universal” BSON DSL.
@frozen enum DocumentFrameSpecifies the interpretation of a length header attached to a document, or a list document.
@frozen struct FieldEncoderA type that can serialize any BSON container element.
@frozen struct HeaderError<Frame> where Frame : BSON.BufferFrameType@frozen struct InputA type for managing BSON parsing state. Most users of this module should not need to interact with it directly.
@frozen struct InputErrorA parser did not receive the expected amount of input.
@frozen enum IntegerOverflowError<Overflowed> where Overflowed : FixedWidthIntegerAn overflow occurred while casting an integer value to a desired type.
@frozen struct KeyA BSON field key. This type wraps a rawValue that is guaranteed to never contain null bytes. (Null bytes in a BSON field key can be exploited to perform SQL injection.)
@frozen struct List@frozen struct Null@frozen struct Output@frozen struct ShapeAn efficient interface for checking the shape of a list or binary array at run time.
@frozen struct ShapeErrorA list had an invalid number of elements or a binary array had an invalid number of bytes.
@frozen struct Timestamp@frozen struct TypeErrorA variant code did not encode a valid BSON type.
@frozen struct TypecastError<Value>A decoder failed to cast a variant to an expected value type.
@frozen enum UTF8FrameSpecifies the interpretation of a length header attached to UTF-8 string.
@frozen struct UTF8View<Bytes> where Bytes : BidirectionalCollection, Bytes.Element == UInt8A BSON UTF-8 string. This string is allowed to contain null bytes.
typealias BinaryArray = BinaryBuffertypealias Millisecond = UnixMillisecondprotocol BitwiseCopyableprotocol Comparable : EquatableA type that can be compared using the relational operators <, <=, >=, and >.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol ExpressibleByIntegerLiteralA type that can be initialized with an integer literal.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Sendableinit(_ high: UInt32, _ middle: UInt32, _ low: UInt32) Creates an identifier with the given high-, middle-, and low-components. The components are interpreted by platform endianness; therefore the values stored into bitPattern may be different if the current host is not big-endian.
init(integerLiteral: StaticBigInt) init(timestamp: UInt32, seed: Seed, ordinal: Ordinal) init(with initialize: (_ memory: UnsafeMutableRawBufferPointer) throws -> ()) rethrows Creates an identifier by delegating to the closure to initialize raw memory. The buffer contains 12 bytes and will be interpreted as a 96-bit, big-endian integer.
let bitPattern: (UInt32, UInt32, UInt32)var description: String { get }var low: UInt32 { get }The low 32 bits of this identifier. The high byte of this integer is the byte at offset +8 of this identifier.
var middle: UInt32 { get }The middle 32 bits of this identifier. The high byte of this integer is the byte at offset +4 of this identifier.
var ordinal: Ordinal { get }The last three bytes of this identifier. The first tuple element is the byte at offset +9 of this identifier.
var seed: Seed { get }The middle five bytes of this identifier. The first tuple element is the byte at offset +4 of this identifier.
var timestamp: UInt32 { get }The high 32 bits of this identifier. The high byte of this integer is the byte at offset +0 of this identifier.
static func < (lhs: `Self`, rhs: `Self`) -> Bool Compares the bytes of this identifier in lexicographical order. This is the same as performing a lexicographic numeric comparison on (timestamp, middle, low). Depending on platform endianness, this may be different from performing a lexicographic numeric comparison on bitPattern directly.
static func == (lhs: `Self`, rhs: `Self`) -> Bool func hash(into hasher: inout Hasher) Hashes the bytes of this identifier in the order they are stored in memory.
typealias Ordinal = (UInt8, UInt8, UInt8)typealias Seed = (UInt8, UInt8, UInt8, UInt8, UInt8)static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.
static func ... (minimum: Self) -> PartialRangeFrom<Self> Returns a partial range extending upward from a lower bound.
static func ... (maximum: Self) -> PartialRangeThrough<Self> Returns a partial range up to, and including, its upper bound.
static func ... (minimum: Self, maximum: Self) -> ClosedRange<Self> Returns a closed range that contains both of its bounds.
static func ..< (maximum: Self) -> PartialRangeUpTo<Self> Returns a partial range up to, but not including, its upper bound.
static func ..< (minimum: Self, maximum: Self) -> Range<Self> Returns a half-open range that contains its lower bound but not its upper bound.
static func <= (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether the value of the first argument is less than or equal to that of the second argument.
static func > (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether the value of the first argument is greater than that of the second argument.
static func >= (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether the value of the first argument is greater than or equal to that of the second argument.
import BSONDecodingprotocol BSONDecodableA type that can be decoded from a BSON variant value backed by some type of storage not particular to the decoded type.
init(bson: BSON.AnyValue) throws import BSONEncodingprotocol BSONEncodableA type that can be encoded to a BSON variant value.
func encode(to field: inout BSON.FieldEncoder)