SequoiaDB
 All Classes Namespaces Files Functions Variables Enumerations Properties Pages
Public Member Functions | Static Public Member Functions | Properties | List of all members
SequoiaDB.Bson.BsonRegularExpression Class Reference

Represents a BSON regular expression value. More...

Inheritance diagram for SequoiaDB.Bson.BsonRegularExpression:
SequoiaDB.Bson.BsonValue

Public Member Functions

 BsonRegularExpression (string pattern)
 Initializes a new instance of the BsonRegularExpression class.
 
 BsonRegularExpression (string pattern, string options)
 Initializes a new instance of the BsonRegularExpression class.
 
 BsonRegularExpression (Regex regex)
 Initializes a new instance of the BsonRegularExpression class.
 
int CompareTo (BsonRegularExpression other)
 Compares this BsonRegularExpression to another BsonRegularExpression.
 
override int CompareTo (BsonValue other)
 Compares the BsonRegularExpression to another BsonValue.
 
bool Equals (BsonRegularExpression rhs)
 Compares this BsonRegularExpression to another BsonRegularExpression.
 
override bool Equals (object obj)
 Compares this BsonRegularExpression to another object.
 
override int GetHashCode ()
 Gets the hash code.
 
Regex ToRegex ()
 Converts the BsonRegularExpression to a Regex.
 
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 implicit operator BsonRegularExpression (Regex value)
 Converts a Regex to a BsonRegularExpression.
 
static implicit operator BsonRegularExpression (string value)
 Converts a string to a BsonRegularExpression.
 
static bool operator!= (BsonRegularExpression lhs, BsonRegularExpression rhs)
 Compares two BsonRegularExpression values.
 
static bool operator== (BsonRegularExpression lhs, BsonRegularExpression rhs)
 Compares two BsonRegularExpression values.
 
static new BsonRegularExpression Create (object value)
 Creates a new BsonRegularExpression.
 
static BsonRegularExpression Create (Regex regex)
 Creates a new instance of the BsonRegularExpression class.
 
static BsonRegularExpression Create (string pattern)
 Creates a new instance of the BsonRegularExpression class.
 
static BsonRegularExpression Create (string pattern, string options)
 Creates a new instance of the BsonRegularExpression class.
 
- 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

string Pattern [get]
 Gets the regular expression pattern.
 
string Options [get]
 Gets the regular expression options.
 
- 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 regular expression value.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonRegularExpression.BsonRegularExpression ( string  pattern)
inline

Initializes a new instance of the BsonRegularExpression class.

Parameters
patternA regular expression pattern.
SequoiaDB.Bson.BsonRegularExpression.BsonRegularExpression ( string  pattern,
string  options 
)
inline

Initializes a new instance of the BsonRegularExpression class.

Parameters
patternA regular expression pattern.
optionsRegular expression options.
SequoiaDB.Bson.BsonRegularExpression.BsonRegularExpression ( Regex  regex)
inline

Initializes a new instance of the BsonRegularExpression class.

Parameters
regexA Regex.

Member Function Documentation

int SequoiaDB.Bson.BsonRegularExpression.CompareTo ( BsonRegularExpression  other)
inline

Compares this BsonRegularExpression to another BsonRegularExpression.

Parameters
otherThe other BsonRegularExpression.
Returns
A 32-bit signed integer that indicates whether this BsonRegularExpression is less than, equal to, or greather than the other.
override int SequoiaDB.Bson.BsonRegularExpression.CompareTo ( BsonValue  other)
inlinevirtual

Compares the BsonRegularExpression to another BsonValue.

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

Implements SequoiaDB.Bson.BsonValue.

static new BsonRegularExpression SequoiaDB.Bson.BsonRegularExpression.Create ( object  value)
inlinestatic

Creates a new BsonRegularExpression.

Parameters
valueAn object to be mapped to a BsonRegularExpression.
Returns
A BsonRegularExpression or null.
static BsonRegularExpression SequoiaDB.Bson.BsonRegularExpression.Create ( Regex  regex)
inlinestatic

Creates a new instance of the BsonRegularExpression class.

Parameters
regexA Regex.
Returns
A BsonRegularExpression.
static BsonRegularExpression SequoiaDB.Bson.BsonRegularExpression.Create ( string  pattern)
inlinestatic

Creates a new instance of the BsonRegularExpression class.

Parameters
patternA regular expression pattern.
Returns
A BsonRegularExpression.
static BsonRegularExpression SequoiaDB.Bson.BsonRegularExpression.Create ( string  pattern,
string  options 
)
inlinestatic

Creates a new instance of the BsonRegularExpression class.

Parameters
patternA regular expression pattern.
optionsRegular expression options.
Returns
A BsonRegularExpression.
bool SequoiaDB.Bson.BsonRegularExpression.Equals ( BsonRegularExpression  rhs)
inline

Compares this BsonRegularExpression to another BsonRegularExpression.

Parameters
rhsThe other BsonRegularExpression.
Returns
True if the two BsonRegularExpression values are equal.
override bool SequoiaDB.Bson.BsonRegularExpression.Equals ( object  obj)
inline

Compares this BsonRegularExpression to another object.

Parameters
objThe other object.
Returns
True if the other object is a BsonRegularExpression and equal to this one.
override int SequoiaDB.Bson.BsonRegularExpression.GetHashCode ( )
inline

Gets the hash code.

Returns
The hash code.
static implicit SequoiaDB.Bson.BsonRegularExpression.operator BsonRegularExpression ( Regex  value)
inlinestatic

Converts a Regex to a BsonRegularExpression.

Parameters
valueA Regex.
Returns
A BsonRegularExpression.
static implicit SequoiaDB.Bson.BsonRegularExpression.operator BsonRegularExpression ( string  value)
inlinestatic

Converts a string to a BsonRegularExpression.

Parameters
valueA string.
Returns
A BsonRegularExpression.
static bool SequoiaDB.Bson.BsonRegularExpression.operator!= ( BsonRegularExpression  lhs,
BsonRegularExpression  rhs 
)
inlinestatic

Compares two BsonRegularExpression values.

Parameters
lhsThe first BsonRegularExpression.
rhsThe other BsonRegularExpression.
Returns
True if the two BsonRegularExpression values are not equal according to ==.
static bool SequoiaDB.Bson.BsonRegularExpression.operator== ( BsonRegularExpression  lhs,
BsonRegularExpression  rhs 
)
inlinestatic

Compares two BsonRegularExpression values.

Parameters
lhsThe first BsonRegularExpression.
rhsThe other BsonRegularExpression.
Returns
True if the two BsonRegularExpression values are equal according to ==.
Regex SequoiaDB.Bson.BsonRegularExpression.ToRegex ( )
inline

Converts the BsonRegularExpression to a Regex.

Returns
A Regex.
override string SequoiaDB.Bson.BsonRegularExpression.ToString ( )
inline

Returns a string representation of the value.

Returns
A string representation of the value.

Property Documentation

string SequoiaDB.Bson.BsonRegularExpression.Options
get

Gets the regular expression options.

string SequoiaDB.Bson.BsonRegularExpression.Pattern
get

Gets the regular expression pattern.


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