Represents a BSON timestamp value. More...

Inheritance diagram for SequoiaDB.Bson.BsonTimestamp:

Public Member Functions
	BsonTimestamp (long value)
	Initializes a new instance of the BsonTimestamp class.

	BsonTimestamp (int timestamp, int increment)
	Initializes a new instance of the BsonTimestamp class.

int	CompareTo (BsonTimestamp other)
	Compares this BsonTimestamp to another BsonTimestamp.

override int	CompareTo (BsonValue other)
	Compares the BsonTimestamp to another BsonValue.

bool	Equals (BsonTimestamp rhs)
	Compares this BsonTimestamp to another BsonTimestamp.

override bool	Equals (object obj)
	Compares this BsonTimestamp to another object.

override int	GetHashCode ()
	Gets the hash code.

override string	ToString ()
	Returns a string representation of the value.

Public Member Functions inherited from SequoiaDB.Bson.BsonValue
virtual BsonValue	Clone ()
	Creates a shallow clone of the BsonValue (see also DeepClone).

int	CompareTypeTo (BsonValue other)
	Compares the type of this BsonValue to the type of another BsonValue.

virtual BsonValue	DeepClone ()
	Creates a deep clone of the BsonValue (see also Clone).

bool	Equals (BsonValue rhs)
	Compares this BsonValue to another BsonValue.

override bool	Equals (object obj)
	Compares this BsonValue to another object.

override int	GetHashCode ()
	Gets the hash code.

bool	ToBoolean ()
	Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).

double	ToDouble ()
	Converts this BsonValue to a Double.

int	ToInt32 ()
	Converts this BsonValue to an Int32.

long	ToInt64 ()
	Converts this BsonValue to an Int64.

void	WriteTo (BsonWriter bsonWriter)
	Writes the BsonValue to a BsonWriter.

Static Public Member Functions
static bool	operator!= (BsonTimestamp lhs, BsonTimestamp rhs)
	Compares two BsonTimestamp values.

static bool	operator== (BsonTimestamp lhs, BsonTimestamp rhs)
	Compares two BsonTimestamp values.

static BsonTimestamp	Create (long value)
	Creates a new instance of the BsonTimestamp class.

static BsonTimestamp	Create (int timestamp, int increment)
	Creates a new instance of the BsonTimestamp class.

static new BsonTimestamp	Create (object value)
	Creates a new BsonTimestamp.

Static Public Member Functions inherited from SequoiaDB.Bson.BsonValue
static	operator bool (BsonValue value)
	Casts a BsonValue to a bool.

static	operator bool? (BsonValue value)
	Casts a BsonValue to a bool?.

static implicit	operator BsonValue (bool value)
	Converts a bool to a BsonValue.

static implicit	operator BsonValue (bool?value)
	Converts a bool? to a BsonValue.

static implicit	operator BsonValue (byte[] value)
	Converts a byte[] to a BsonValue.

static implicit	operator BsonValue (DateTime value)
	Converts a DateTime to a BsonValue.

static implicit	operator BsonValue (DateTime?value)
	Converts a DateTime? to a BsonValue.

static implicit	operator BsonValue (double value)
	Converts a double to a BsonValue.

static implicit	operator BsonValue (double?value)
	Converts a double? to a BsonValue.

static implicit	operator BsonValue (Enum value)
	Converts an Enum to a BsonValue.

static implicit	operator BsonValue (Guid value)
	Converts a Guid to a BsonValue.

static implicit	operator BsonValue (Guid?value)
	Converts a Guid? to a BsonValue.

static implicit	operator BsonValue (int value)
	Converts an int to a BsonValue.

static implicit	operator BsonValue (int?value)
	Converts an int? to a BsonValue.

static implicit	operator BsonValue (long value)
	Converts a long to a BsonValue.

static implicit	operator BsonValue (long?value)
	Converts a long? to a BsonValue.

static implicit	operator BsonValue (decimal value)
	Converts a decimal to a BsonValue.

static implicit	operator BsonValue (decimal?value)
	Converts a decimal? to a BsonValue.

static implicit	operator BsonValue (ObjectId value)
	Converts an ObjectId to a BsonValue.

static implicit	operator BsonValue (ObjectId?value)
	Converts an ObjectId? to a BsonValue.

static implicit	operator BsonValue (Regex value)
	Converts a Regex to a BsonValue.

static implicit	operator BsonValue (string value)
	Converts a string to a BsonValue.

static	operator byte[] (BsonValue value)
	Casts a BsonValue to a byte[].

static	operator DateTime (BsonValue value)
	Casts a BsonValue to a DateTime.

static	operator DateTime? (BsonValue value)
	Casts a BsonValue to a DateTime?.

static	operator double (BsonValue value)
	Casts a BsonValue to a double.

static	operator double? (BsonValue value)
	Casts a BsonValue to a double?.

static	operator Guid (BsonValue value)
	Casts a BsonValue to a Guid.

static	operator Guid? (BsonValue value)
	Casts a BsonValue to a Guid?.

static	operator int (BsonValue value)
	Casts a BsonValue to an int.

static	operator int? (BsonValue value)
	Casts a BsonValue to an int?.

static	operator long (BsonValue value)
	Casts a BsonValue to a long.

static	operator long? (BsonValue value)
	Casts a BsonValue to a long?.

static	operator decimal (BsonValue value)
	Casts a BsonValue to a decimal.

static	operator decimal? (BsonValue value)
	Casts a BsonValue to a decimal?.

static	operator ObjectId (BsonValue value)
	Casts a BsonValue to an ObjectId.

static	operator ObjectId? (BsonValue value)
	Casts a BsonValue to an ObjectId?.

static	operator Regex (BsonValue value)
	Casts a BsonValue to a Regex.

static	operator string (BsonValue value)
	Casts a BsonValue to a string.

static bool	operator< (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static bool	operator<= (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static bool	operator!= (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static bool	operator== (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static bool	operator> (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static bool	operator>= (BsonValue lhs, BsonValue rhs)
	Compares two BsonValues.

static BsonValue	Create (object value)
	Creates a new instance of the BsonValue class.

static BsonValue	ReadFrom (BsonReader bsonReader)
	Reads one BsonValue from a BsonReader.

Properties
long	Value `[get]`
	Gets the value of this BsonTimestamp.

int	Increment `[get]`
	Gets the increment.

int	Timestamp `[get]`
	Gets the timestamp.

Properties inherited from SequoiaDB.Bson.BsonValue
bool	AsBoolean `[get]`
	Casts the BsonValue to a Boolean (throws an InvalidCastException if the cast is not valid).

BsonArray	AsBsonArray `[get]`
	Casts the BsonValue to a BsonArray (throws an InvalidCastException if the cast is not valid).

BsonBinaryData	AsBsonBinaryData `[get]`
	Casts the BsonValue to a BsonBinaryData (throws an InvalidCastException if the cast is not valid).

BsonDateTime	AsBsonDateTime `[get]`
	Casts the BsonValue to a BsonDateTime (throws an InvalidCastException if the cast is not valid).

BsonDocument	AsBsonDocument `[get]`
	Casts the BsonValue to a BsonDocument (throws an InvalidCastException if the cast is not valid).

BsonJavaScript	AsBsonJavaScript `[get]`
	Casts the BsonValue to a BsonJavaScript (throws an InvalidCastException if the cast is not valid).

BsonJavaScriptWithScope	AsBsonJavaScriptWithScope `[get]`
	Casts the BsonValue to a BsonJavaScriptWithScope (throws an InvalidCastException if the cast is not valid).

BsonMaxKey	AsBsonMaxKey `[get]`
	Casts the BsonValue to a BsonMaxKey (throws an InvalidCastException if the cast is not valid).

BsonMinKey	AsBsonMinKey `[get]`
	Casts the BsonValue to a BsonMinKey (throws an InvalidCastException if the cast is not valid).

BsonNull	AsBsonNull `[get]`
	Casts the BsonValue to a BsonNull (throws an InvalidCastException if the cast is not valid).

BsonRegularExpression	AsBsonRegularExpression `[get]`
	Casts the BsonValue to a BsonRegularExpression (throws an InvalidCastException if the cast is not valid).

BsonSymbol	AsBsonSymbol `[get]`
	Casts the BsonValue to a BsonSymbol (throws an InvalidCastException if the cast is not valid).

BsonTimestamp	AsBsonTimestamp `[get]`
	Casts the BsonValue to a BsonTimestamp (throws an InvalidCastException if the cast is not valid).

BsonDecimal	AsBsonDecimal `[get]`
	Casts the BsonValue to a BsonDecimal (throws an InvalidCastException if the cast is not valid).

decimal	AsDecimal `[get]`
	Casts the BsonValue to a decimal (throws an InvalidCastException if the cast is not valid).

BsonUndefined	AsBsonUndefined `[get]`
	Casts the BsonValue to a BsonUndefined (throws an InvalidCastException if the cast is not valid).

BsonValue	AsBsonValue `[get]`
	Casts the BsonValue to a BsonValue (a way of upcasting subclasses of BsonValue to BsonValue at compile time).

byte[]	AsByteArray `[get]`
	Casts the BsonValue to a Byte[] (throws an InvalidCastException if the cast is not valid).

DateTime	AsDateTime `[get]`
	Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).

double	AsDouble `[get]`
	Casts the BsonValue to a Double (throws an InvalidCastException if the cast is not valid).

Guid	AsGuid `[get]`
	Casts the BsonValue to a Guid (throws an InvalidCastException if the cast is not valid).

int	AsInt32 `[get]`
	Casts the BsonValue to an Int32 (throws an InvalidCastException if the cast is not valid).

DateTime	AsLocalTime `[get]`
	Casts the BsonValue to a DateTime in the local timezone (throws an InvalidCastException if the cast is not valid).

long	AsInt64 `[get]`
	Casts the BsonValue to a Int64 (throws an InvalidCastException if the cast is not valid).

bool	AsNullableBoolean `[get]`
	Casts the BsonValue to a Nullable{Boolean} (throws an InvalidCastException if the cast is not valid).

DateTime	AsNullableDateTime `[get]`
	Casts the BsonValue to a Nullable{DateTime} (throws an InvalidCastException if the cast is not valid).

double	AsNullableDouble `[get]`
	Casts the BsonValue to a Nullable{Double} (throws an InvalidCastException if the cast is not valid).

Guid	AsNullableGuid `[get]`
	Casts the BsonValue to a Nullable{Guid} (throws an InvalidCastException if the cast is not valid).

int	AsNullableInt32 `[get]`
	Casts the BsonValue to a Nullable{Int32} (throws an InvalidCastException if the cast is not valid).

long	AsNullableInt64 `[get]`
	Casts the BsonValue to a Nullable{Int64} (throws an InvalidCastException if the cast is not valid).

decimal	AsNullableDecimal `[get]`
	Casts the BsonValue to a Nullable{decimal} (throws an InvalidCastException if the cast is not valid).

ObjectId	AsNullableObjectId `[get]`
	Casts the BsonValue to a Nullable{ObjectId} (throws an InvalidCastException if the cast is not valid).

ObjectId	AsObjectId `[get]`
	Casts the BsonValue to an ObjectId (throws an InvalidCastException if the cast is not valid).

Regex	AsRegex `[get]`
	Casts the BsonValue to a Regex (throws an InvalidCastException if the cast is not valid).

string	AsString `[get]`
	Casts the BsonValue to a String (throws an InvalidCastException if the cast is not valid).

DateTime	AsUniversalTime `[get]`
	Casts the BsonValue to a DateTime in UTC (throws an InvalidCastException if the cast is not valid).

BsonType	BsonType `[get]`
	Gets the BsonType of this BsonValue.

bool	IsBoolean `[get]`
	Tests whether this BsonValue is a Boolean.

bool	IsBsonArray `[get]`
	Tests whether this BsonValue is a BsonArray.

bool	IsBsonBinaryData `[get]`
	Tests whether this BsonValue is a BsonBinaryData.

bool	IsBsonDateTime `[get]`
	Tests whether this BsonValue is a BsonDateTime.

bool	IsBsonDocument `[get]`
	Tests whether this BsonValue is a BsonDocument.

bool	IsBsonJavaScript `[get]`
	Tests whether this BsonValue is a BsonJavaScript.

bool	IsBsonJavaScriptWithScope `[get]`
	Tests whether this BsonValue is a BsonJavaScriptWithScope.

bool	IsBsonMaxKey `[get]`
	Tests whether this BsonValue is a BsonMaxKey.

bool	IsBsonMinKey `[get]`
	Tests whether this BsonValue is a BsonMinKey.

bool	IsBsonNull `[get]`
	Tests whether this BsonValue is a BsonNull.

bool	IsBsonRegularExpression `[get]`
	Tests whether this BsonValue is a BsonRegularExpression.

bool	IsBsonSymbol `[get]`
	Tests whether this BsonValue is a BsonSymbol .

bool	IsBsonTimestamp `[get]`
	Tests whether this BsonValue is a BsonTimestamp.

bool	IsBsonDecimal `[get]`
	Tests whether this BsonValue is a BsonDecimal.

bool	IsBsonUndefined `[get]`
	Tests whether this BsonValue is a BsonUndefined.

bool	IsDateTime `[get]`
	Tests whether this BsonValue is a DateTime.

bool	IsDouble `[get]`
	Tests whether this BsonValue is a Double.

bool	IsGuid `[get]`
	Tests whether this BsonValue is a Guid.

bool	IsInt32 `[get]`
	Tests whether this BsonValue is an Int32.

bool	IsInt64 `[get]`
	Tests whether this BsonValue is an Int64.

bool	IsNumeric `[get]`
	Tests whether this BsonValue is a numeric value.

bool	IsObjectId `[get]`
	Tests whether this BsonValue is an ObjectId .

bool	IsString `[get]`
	Tests whether this BsonValue is a String.

virtual object	RawValue `[get]`
	Gets the raw value of this BsonValue (or null if this BsonValue doesn't have a single scalar value).

Additional Inherited Members
Protected Member Functions inherited from SequoiaDB.Bson.BsonValue
	BsonValue (BsonType bsonType)
	Initializes a new instance of the BsonValue class.

virtual bool	OperatorEqualsImplementation (BsonValue rhs)
	Implementation of operator ==.

Detailed Description

Represents a BSON timestamp value.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonTimestamp.BsonTimestamp ( long value )

inline

Initializes a new instance of the BsonTimestamp class.

Parameters

value The combined timestamp/increment value. e.g. when timstamp is "2147483647s", and the increment is "123456us"(both the timestamp and the increment are should be int32 values, besides, increment should in the range of [0us, 999999us]), the value = (long)(((ulong)(uint)2147483647 << 32) | ((ulong)(uint)123456)).

SequoiaDB.Bson.BsonTimestamp.BsonTimestamp	(	int	timestamp,
		int	increment
	)

inline

Initializes a new instance of the BsonTimestamp class.

Parameters

timestamp	The seconds since epoch.
increment	The microseconds in range of [0us, 999999us], while the 'inc' is out of range, the carry will occur.

Member Function Documentation

int SequoiaDB.Bson.BsonTimestamp.CompareTo ( BsonTimestamp other )

inline

Compares this BsonTimestamp to another BsonTimestamp.

Parameters

other The other BsonTimestamp.

Returns: A 32-bit signed integer that indicates whether this BsonTimestamp is less than, equal to, or greather than the other.

override int SequoiaDB.Bson.BsonTimestamp.CompareTo ( BsonValue other )

inlinevirtual

Compares the BsonTimestamp to another BsonValue.

Parameters

other The other BsonValue.

Returns: A 32-bit signed integer that indicates whether this BsonTimestamp is less than, equal to, or greather than the other BsonValue.

Implements SequoiaDB.Bson.BsonValue.

static BsonTimestamp SequoiaDB.Bson.BsonTimestamp.Create ( long value )

inlinestatic

Creates a new instance of the BsonTimestamp class.

Parameters

value The combined timestamp/increment value.

Returns: A BsonTimestamp.

static BsonTimestamp SequoiaDB.Bson.BsonTimestamp.Create	(	int	timestamp,
		int	increment
	)

inlinestatic

Creates a new instance of the BsonTimestamp class.

Parameters

timestamp	The timestamp.
increment	The increment.

Returns: A BsonTimestamp.

static new BsonTimestamp SequoiaDB.Bson.BsonTimestamp.Create ( object value )

inlinestatic

Creates a new BsonTimestamp.

Parameters

value An object to be mapped to a BsonTimestamp.

Returns: A BsonTimestamp or null.

bool SequoiaDB.Bson.BsonTimestamp.Equals ( BsonTimestamp rhs )

inline

Compares this BsonTimestamp to another BsonTimestamp.

Parameters

rhs	The other BsonTimestamp.

Returns: True if the two BsonTimestamp values are equal.

override bool SequoiaDB.Bson.BsonTimestamp.Equals ( object obj )

inline

Compares this BsonTimestamp to another object.

Parameters

obj	The other object.

Returns: True if the other object is a BsonTimestamp and equal to this one.

override int SequoiaDB.Bson.BsonTimestamp.GetHashCode ( )

inline

Gets the hash code.

Returns: The hash code.

static bool SequoiaDB.Bson.BsonTimestamp.operator!=	(	BsonTimestamp	lhs,
		BsonTimestamp	rhs
	)

inlinestatic

Compares two BsonTimestamp values.

Parameters

lhs	The first BsonTimestamp.
rhs	The other BsonTimestamp.

Returns: True if the two BsonTimestamp values are not equal according to ==.

static bool SequoiaDB.Bson.BsonTimestamp.operator==	(	BsonTimestamp	lhs,
		BsonTimestamp	rhs
	)

inlinestatic

Compares two BsonTimestamp values.

Parameters

lhs	The first BsonTimestamp.
rhs	The other BsonTimestamp.

Returns: True if the two BsonTimestamp values are equal according to ==.

override string SequoiaDB.Bson.BsonTimestamp.ToString ( )

inline

Returns a string representation of the value.

Returns: A string representation of the value.

Property Documentation

int SequoiaDB.Bson.BsonTimestamp.Increment

get

Gets the increment.

int SequoiaDB.Bson.BsonTimestamp.Timestamp

get

Gets the timestamp.

long SequoiaDB.Bson.BsonTimestamp.Value

get

Gets the value of this BsonTimestamp.

The documentation for this class was generated from the following file:

BsonTimestamp.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation