enum classafBson::BsonType
sys::Obj sys::Enum afBson::BsonType
@
Serializable { simple=true }
A list of BSON types.
- ARRAY
- BINARY
- BOOLEAN
- CODE
- CODE_W_SCOPE
- DATE
- DB_POINTER
- DECIMAL_128
- DOCUMENT
- DOUBLE
- EOO
- INTEGER_32
- INTEGER_64
- MAX_KEY
- MIN_KEY
- NULL
- OBJECT_ID
- REGEX
- STRING
- SYMBOL
- TIMESTAMP
- UNDEFINED
- ARRAY
const static BsonType ARRAY := ...
Maps to List. All vals must be valid BSON types.
- BINARY
const static BsonType BINARY := ...
- BOOLEAN
const static BsonType BOOLEAN := ...
Maps to Bool.
- CODE
const static BsonType CODE := ...
Maps to Str (read only).
- CODE_W_SCOPE
const static BsonType CODE_W_SCOPE := ...
Code with scope.
(Deprecated, not used.)
- DATE
const static BsonType DATE := ...
Maps to DateTime.
- DB_POINTER
const static BsonType DB_POINTER := ...
DBPointer.
(Deprecated, not used.)
- DECIMAL_128
const static BsonType DECIMAL_128 := ...
128-bit decimal floating point number.
(Not supported.)
- DOCUMENT
const static BsonType DOCUMENT := ...
Maps to Map. All keys must be
Str
and all vals must be valid BSON types.- DOUBLE
const static BsonType DOUBLE := ...
Maps to Float.
- EOO
const static BsonType EOO := ...
End-Of-Object. For internal use.
- INTEGER_32
const static BsonType INTEGER_32 := ...
Maps to Int (read only).
- INTEGER_64
const static BsonType INTEGER_64 := ...
Maps to Int.
- MAX_KEY
const static BsonType MAX_KEY := ...
Maps to MaxKey. For internal use.
- MIN_KEY
const static BsonType MIN_KEY := ...
Maps to MinKey. For internal use.
- NULL
const static BsonType NULL := ...
Maps to
null
.- OBJECT_ID
const static BsonType OBJECT_ID := ...
Maps to ObjectId.
- REGEX
const static BsonType REGEX := ...
Maps to Regex.
- STRING
const static BsonType STRING := ...
Maps to Str.
- SYMBOL
const static BsonType SYMBOL := ...
Symbol.
(Deprecated, not used.)
- TIMESTAMP
const static BsonType TIMESTAMP := ...
Maps to Timestamp.
- UNDEFINED
const static BsonType UNDEFINED := ...
Undefined.
(Deprecated, not used.)
- fromObj
static new fromObj(Obj? obj, Bool checked := true)
Determines a BSON type from the type of the given object. Throws an
ArgErr
if invalid.- fromStr
static new fromStr(Str name, Bool checked := true)
Return the BsonType instance for the specified name. If not a valid name and checked is false return null, otherwise throw ParseErr.
- fromType
static new fromType(Type? type, Bool checked := true)
Throws an
ArgErr
if invalid.- fromValue
static new fromValue(Int value, Bool checked := true)
Throws an
ArgErr
if invalid.- isBsonLiteral
static Bool isBsonLiteral(Type? type)
Returns true if the given
Type
is a BSON literal.null
andBuf
are considered literals, whereasMaps
andLists
are not.BsonType.isBsonLiteral(Int#) // --> true BsonType.isBsonLiteral(Code#) // --> true BsonType.isBsonLiteral(null) // --> true BsonType.isBsonLiteral(List#) // --> false BsonType.isBsonLiteral(Str:Obj?#) // --> false
- type
const Type? type
The Fantom
Type
(if any) this BSON type maps to.- vals
const static BsonType[] vals := ...
List of BsonType values indexed by ordinal
- value
const Int value
The value that uniquely identifies the type as per the BSON spec.