AnyBSON Enumeration Reference


                    
                    
                    double(_:)

A BSON double.

Declaration

Swift

case double(Double)

Show on GitHub


                    
                    
                    string(_:)

A BSON string.

Declaration

Swift

case string(String)

Show on GitHub


                    
                    
                    document(_:)

A BSON document.

Declaration

Swift

indirect case document(Document)

Show on GitHub


                    
                    
                    array(_:)

A BSON array.

Declaration

Swift

indirect case array([AnyBSON?])

Show on GitHub


                    
                    
                    binary(_:)

A BSON binary.

Declaration

Swift

case binary(Data)

Show on GitHub


                    
                    
                    objectId(_:)

A BSON ObjectId.

Declaration

Swift

case objectId(ObjectId)

Show on GitHub


                    
                    
                    bool(_:)

A BSON boolean.

Declaration

Swift

case bool(Bool)

Show on GitHub


                    
                    
                    datetime(_:)

A BSON UTC datetime.

Declaration

Swift

case datetime(Date)

Show on GitHub


                    
                    
                    regex(_:)

A BSON regular expression.

Declaration

Swift

case regex(NSRegularExpression)

Show on GitHub


                    
                    
                    int32(_:)

A BSON int32.

Declaration

Swift

case int32(Int32)

Show on GitHub


                    
                    
                    timestamp(_:)

A BSON timestamp.

Declaration

Swift

case timestamp(Date)

Show on GitHub


                    
                    
                    int64(_:)

A BSON int64.

Declaration

Swift

case int64(Int64)

Show on GitHub


                    
                    
                    decimal128(_:)

A BSON Decimal128.

Declaration

Swift

case decimal128(Decimal128)

Show on GitHub


                    
                    
                    minKey

A BSON minKey.

Declaration

Swift

case minKey

Show on GitHub


                    
                    
                    maxKey

A BSON maxKey.

Declaration

Swift

case maxKey

Show on GitHub


                    
                    
                    null

A BSON null type.

Declaration

Swift

case null

Show on GitHub


                    
                    
                    init(_:)

Initialize a BSON from an integer. On 64-bit systems, this will result in an .int64. On 32-bit systems, this will result in an .int32.

Declaration

Swift

public init(_ int: Int)

Show on GitHub


                    
                    
                    init(_:)

Initialize a BSON from a type T. If this is not a valid BSON type, if will be considered BSON null type and will return nil.

Declaration

Swift

public init<T>(_ bson: T) where T : BSON

Show on GitHub


                    
                    
                    int32Value

If this BSON is an .int32, return it as an Int32. Otherwise, return nil.

Declaration

Swift

public var int32Value: Int32? { get }

Show on GitHub


                    
                    
                    regexValue

If this BSON is a .regex, return it as a RegularExpression. Otherwise, return nil.

Declaration

Swift

public var regexValue: NSRegularExpression? { get }

Show on GitHub


                    
                    
                    int64Value

If this BSON is an .int64, return it as an Int64. Otherwise, return nil.

Declaration

Swift

public var int64Value: Int64? { get }

Show on GitHub


                    
                    
                    objectIdValue

If this BSON is an .objectId, return it as an ObjectId. Otherwise, return nil.

Declaration

Swift

public var objectIdValue: ObjectId? { get }

Show on GitHub


                    
                    
                    dateValue

If this BSON is a .date, return it as a Date. Otherwise, return nil.

Declaration

Swift

public var dateValue: Date? { get }

Show on GitHub


                    
                    
                    arrayValue

If this BSON is an .array, return it as an [BSON]. Otherwise, return nil.

Declaration

Swift

public var arrayValue: [AnyBSON?]? { get }

Show on GitHub


                    
                    
                    stringValue

If this BSON is a .string, return it as a String. Otherwise, return nil.

Declaration

Swift

public var stringValue: String? { get }

Show on GitHub


                    
                    
                    documentValue

If this BSON is a .document, return it as a Document. Otherwise, return nil.

Declaration

Swift

public var documentValue: Document? { get }

Show on GitHub


                    
                    
                    boolValue

If this BSON is a .bool, return it as an Bool. Otherwise, return nil.

Declaration

Swift

public var boolValue: Bool? { get }

Show on GitHub


                    
                    
                    binaryValue

If this BSON is a .binary, return it as a Binary. Otherwise, return nil.

Declaration

Swift

public var binaryValue: Data? { get }

Show on GitHub


                    
                    
                    doubleValue

If this BSON is a .double, return it as a Double. Otherwise, return nil.

Declaration

Swift

public var doubleValue: Double? { get }

Show on GitHub


                    
                    
                    decimal128Value

If this BSON is a .decimal128, return it as a Decimal128. Otherwise, return nil.

Declaration

Swift

public var decimal128Value: Decimal128? { get }

Show on GitHub


                    
                    
                    timestampValue

If this BSON is a .timestamp, return it as a Timestamp. Otherwise, return nil.

Declaration

Swift

public var timestampValue: Date? { get }

Show on GitHub


                    
                    
                    isNull

If this BSON is a .null return true. Otherwise, false.

Declaration

Swift

public var isNull: Bool { get }

Show on GitHub


                    
                    
                    asInt()

Return this BSON as an Int if possible. This will coerce non-integer numeric cases (e.g. .double) into an Int if such coercion would be lossless.

Declaration

Swift

public func asInt() -> Int?

Show on GitHub


                    
                    
                    asInt32()

Return this BSON as an Int32 if possible. This will coerce numeric cases (e.g. .double) into an Int32 if such coercion would be lossless.

Declaration

Swift

public func asInt32() -> Int32?

Show on GitHub


                    
                    
                    asInt64()

Return this BSON as an Int64 if possible. This will coerce numeric cases (e.g. .double) into an Int64 if such coercion would be lossless.

Declaration

Swift

public func asInt64() -> Int64?

Show on GitHub


                    
                    
                    asDouble()

Return this BSON as a Double if possible. This will coerce numeric cases (e.g. .decimal128) into a Double if such coercion would be lossless.

Declaration

Swift

public func asDouble() -> Double?

Show on GitHub


                    
                    
                    asDecimal128()

Return this BSON as a Decimal128 if possible. This will coerce numeric cases (e.g. .double) into a Decimal128 if such coercion would be lossless.

Declaration

Swift

public func asDecimal128() -> Decimal128?

Show on GitHub


                    
                    
                    value()

Return this BSON as a T if possible, otherwise nil.

Declaration

Swift

public func value<T>() -> T? where T : BSON

Show on GitHub


                    
                    
                    init(stringLiteral:)

Declaration

Swift

public init(stringLiteral value: String)

Show on GitHub


                    
                    
                    init(booleanLiteral:)

Declaration

Swift

public init(booleanLiteral value: Bool)

Show on GitHub


                    
                    
                    init(floatLiteral:)

Declaration

Swift

public init(floatLiteral value: Double)

Show on GitHub


                    
                    
                    init(integerLiteral:)

Initialize a BSON from an integer. On 64-bit systems, this will result in an .int64. On 32-bit systems, this will result in an .int32.

Declaration

Swift

public init(integerLiteral value: Int)

Show on GitHub


                    
                    
                    init(dictionaryLiteral:)

Declaration

Swift

public init(dictionaryLiteral elements: (String, AnyBSON?)...)

Show on GitHub


                    
                    
                    init(arrayLiteral:)

Declaration

Swift

public init(arrayLiteral elements: AnyBSON?...)

Show on GitHub