BsonObjectID

Represents a BSON object id (Bson.Type.binData).

struct BsonObjectID {

this(ubyte[] bytes);

static BsonObjectID fromString(string str);

alias fromHexString = fromString;

static BsonObjectID generate(SysTime time);

static BsonObjectID createDateID(SysTime time);

bool valid [@property getter];

SysTime timeStamp [@property getter];

int opCmp(BsonObjectID other);

string toString();

inout(ubyte)[] opCast();

}

Constructors

this this(ubyte[] bytes): Constructs a new object ID from the given raw byte array.

Members

Aliases

fromHexString alias fromHexString = fromString: Creates an on object ID from a string in standard hexa-decimal form.

Functions

opCast inout(ubyte)[] opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCmp int opCmp(BsonObjectID other): Allows for relational comparison of different IDs.
toString string toString(): Converts the ID to its standard hexa-decimal string representation.

Properties

timeStamp SysTime timeStamp [@property getter]: Extracts the time/date portion of the object ID.
valid bool valid [@property getter]: Returns true for any non-zero ID.

Static functions

createDateID BsonObjectID createDateID(SysTime time): Creates a pseudo object ID that matches the given date.
fromString BsonObjectID fromString(string str): Creates an on object ID from a string in standard hexa-decimal form.
generate BsonObjectID generate(SysTime time): Generates a unique object ID. * * By default it will use Clock.currTime(UTC()) as the timestamp * which guarantees that BsonObjectIDs are chronologically * sorted.

Meta

Source

See Implementation

index vibe data bson aliases

bdata_t

functions

structs

templates