Represents a BSON JavaScript value with a scope. More...

Inheritance diagram for SequoiaDB.Bson.BsonJavaScriptWithScope:

Public Member Functions
	BsonJavaScriptWithScope (string code, BsonDocument scope)
	Initializes a new instance of the BsonJavaScriptWithScope class.

override BsonValue	Clone ()
	Creates a shallow clone of the BsonJavaScriptWithScope (see also DeepClone).

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

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

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

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

override bool	Equals (object obj)
	Compares this BsonJavaScriptWithScope 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.BsonJavaScript
	BsonJavaScript (string code)
	Initializes a new instance of the BsonJavaScript class.

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

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

override bool	Equals (object obj)
	Compares this BsonJavaScript 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
int	CompareTypeTo (BsonValue other)
	Compares the type of this BsonValue to the type of another BsonValue.

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!= (BsonJavaScriptWithScope lhs, BsonJavaScriptWithScope rhs)
	Compares two BsonJavaScriptWithScope values.

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

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

static BsonJavaScriptWithScope	Create (string code, BsonDocument scope)
	Creates a new instance of the BsonJavaScript class.

Static Public Member Functions inherited from SequoiaDB.Bson.BsonJavaScript
static bool	operator!= (BsonJavaScript lhs, BsonJavaScript rhs)
	Compares two BsonJavaScript values.

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

static implicit	operator BsonJavaScript (string code)
	Converts a string to a BsonJavaScript.

static BsonJavaScript	Create (string code)
	Creates a new instance of the BsonJavaScript class.

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

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
BsonDocument	Scope `[get]`
	Gets the scope (a set of variables with values).

Properties inherited from SequoiaDB.Bson.BsonJavaScript
string	Code `[get]`
	Gets the JavaScript code.

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.BsonJavaScript
	BsonJavaScript (string code, BsonType bsonType)
	Initializes a new instance of the BsonJavaScript class (only called by BsonJavaScriptWithScope).

Detailed Description

Represents a BSON JavaScript value with a scope.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonJavaScriptWithScope.BsonJavaScriptWithScope	(	string	code,
		BsonDocument	scope
	)

inline

Initializes a new instance of the BsonJavaScriptWithScope class.

Parameters

code	The JavaScript code.
scope	A scope (a set of variables with values).

Member Function Documentation

override BsonValue SequoiaDB.Bson.BsonJavaScriptWithScope.Clone ( )

inlinevirtual

Creates a shallow clone of the BsonJavaScriptWithScope (see also DeepClone).

Returns: A shallow clone of the BsonJavaScriptWithScope.

Reimplemented from SequoiaDB.Bson.BsonValue.

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

inline

Compares this BsonJavaScriptWithScope to another BsonJavaScriptWithScope.

Parameters

other The other BsonJavaScriptWithScope.

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

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

inlinevirtual

Compares the BsonJavaScriptWithScope to another BsonValue.

Parameters

other The other BsonValue.

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

Reimplemented from SequoiaDB.Bson.BsonJavaScript.

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

inlinestatic

Creates a new BsonJavaScriptWithScope.

Parameters

value An object to be mapped to a BsonJavaScriptWithScope.

Returns: A BsonJavaScriptWithScope or null.

static BsonJavaScriptWithScope SequoiaDB.Bson.BsonJavaScriptWithScope.Create	(	string	code,
		BsonDocument	scope
	)

inlinestatic

Creates a new instance of the BsonJavaScript class.

Parameters

code	A string containing JavaScript code.
scope	A scope (a set of variable with values).

Returns: A BsonJavaScript.

override BsonValue SequoiaDB.Bson.BsonJavaScriptWithScope.DeepClone ( )

inlinevirtual

Creates a deep clone of the BsonJavaScriptWithScope (see also Clone).

Returns: A deep clone of the BsonJavaScriptWithScope.

Reimplemented from SequoiaDB.Bson.BsonValue.

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

inline

Compares this BsonJavaScriptWithScope to another BsonJavaScriptWithScope.

Parameters

rhs	The other BsonJavaScriptWithScope.

Returns: True if the two BsonJavaScriptWithScope values are equal.

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

inline

Compares this BsonJavaScriptWithScope to another object.

Parameters

obj	The other object.

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

override int SequoiaDB.Bson.BsonJavaScriptWithScope.GetHashCode ( )

inline

Gets the hash code.

Returns: The hash code.

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

inlinestatic

Compares two BsonJavaScriptWithScope values.

Parameters

lhs	The first BsonJavaScriptWithScope.
rhs	The other BsonJavaScriptWithScope.

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

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

inlinestatic

Compares two BsonJavaScriptWithScope values.

Parameters

lhs	The first BsonJavaScriptWithScope.
rhs	The other BsonJavaScriptWithScope.

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

override string SequoiaDB.Bson.BsonJavaScriptWithScope.ToString ( )

inline

Returns a string representation of the value.

Returns: A string representation of the value.

Property Documentation

BsonDocument SequoiaDB.Bson.BsonJavaScriptWithScope.Scope

get

Gets the scope (a set of variables with values).

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

BsonJavaScriptWithScope.cs

Public Member Functions

Static Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation