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

Represents a BSON array. More...

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

Public Member Functions

 BsonArray ()
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< bool > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< BsonValue > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< DateTime > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< double > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< int > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< long > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< ObjectId > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable< string > values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (IEnumerable values)
 Initializes a new instance of the BsonArray class.
 
 BsonArray (int capacity)
 Initializes a new instance of the BsonArray class.
 
BsonArray Add (BsonValue value)
 Adds an element to the array.
 
BsonArray AddRange (IEnumerable< bool > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< BsonValue > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< DateTime > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< double > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< int > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< long > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< ObjectId > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable< string > values)
 Adds multiple elements to the array.
 
BsonArray AddRange (IEnumerable values)
 Adds multiple elements to the array.
 
override BsonValue Clone ()
 Creates a shallow clone of the array (see also DeepClone).
 
void Clear ()
 Clears the array.
 
int CompareTo (BsonArray other)
 Compares the array to another array.
 
override int CompareTo (BsonValue other)
 Compares the array to another BsonValue.
 
bool Contains (BsonValue value)
 Tests whether the array contains a value.
 
void CopyTo (BsonValue[] array, int arrayIndex)
 Copies elements from this array to another array.
 
void CopyTo (object[] array, int arrayIndex)
 Copies elements from this array to another array as raw values (see BsonValue.RawValue).
 
override BsonValue DeepClone ()
 Creates a deep clone of the array (see also Clone).
 
bool Equals (BsonArray rhs)
 Compares this array to another array.
 
override bool Equals (object obj)
 Compares this BsonArray to another object.
 
IEnumerator< BsonValueGetEnumerator ()
 Gets an enumerator that can enumerate the elements of the array.
 
override int GetHashCode ()
 Gets the hash code.
 
int IndexOf (BsonValue value)
 Gets the index of a value in the array.
 
int IndexOf (BsonValue value, int index)
 Gets the index of a value in the array.
 
int IndexOf (BsonValue value, int index, int count)
 Gets the index of a value in the array.
 
void Insert (int index, BsonValue value)
 Inserts a new value into the array.
 
bool Remove (BsonValue value)
 Removes the first occurrence of a value from the array.
 
void RemoveAt (int index)
 Removes an element from the array.
 
BsonValue[] ToArray ()
 Converts the BsonArray to an array of BsonValues.
 
List< BsonValueToList ()
 Converts the BsonArray to a list of BsonValues.
 
override string ToString ()
 Returns a string representation of the array.
 
new void WriteTo (BsonWriter bsonWriter)
 Writes the array to a BsonWriter.
 
- 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!= (BsonArray lhs, BsonArray rhs)
 Compares two BsonArray values.
 
static bool operator== (BsonArray lhs, BsonArray rhs)
 Compares two BsonArray values.
 
static BsonArray Create (IEnumerable< bool > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< BsonValue > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< DateTime > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< double > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< int > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< long > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< ObjectId > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable< string > values)
 Creates a new BsonArray.
 
static BsonArray Create (IEnumerable values)
 Creates a new BsonArray.
 
static new BsonArray Create (object value)
 Creates a new BsonArray.
 
static new BsonArray ReadFrom (BsonReader bsonReader)
 Reads a BsonArray from a BsonReader.
 
- 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

int Capacity [get, set]
 Gets or sets the total number of elements the internal data structure can hold without resizing.
 
int Count [get]
 Gets the count of array elements.
 
bool IsReadOnly [get]
 Gets whether the array is read-only.
 
IEnumerable< object > RawValues [get]
 Gets the array elements as raw values (see BsonValue.RawValue).
 
IEnumerable< BsonValueValues [get]
 Gets the array elements.
 
BsonValue this[int index] [get, set]
 Gets or sets an array element.
 
- 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 array.

Constructor & Destructor Documentation

SequoiaDB.Bson.BsonArray.BsonArray ( )
inline

Initializes a new instance of the BsonArray class.

SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< bool >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< BsonValue values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< DateTime >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< double >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< int >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< long >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< ObjectId values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable< string >  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( IEnumerable  values)
inline

Initializes a new instance of the BsonArray class.

Parameters
valuesA list of values to add to the array.
SequoiaDB.Bson.BsonArray.BsonArray ( int  capacity)
inline

Initializes a new instance of the BsonArray class.

Parameters
capacityThe initial capacity of the array.

Member Function Documentation

BsonArray SequoiaDB.Bson.BsonArray.Add ( BsonValue  value)
inline

Adds an element to the array.

Parameters
valueThe value to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< bool >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< BsonValue values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< DateTime >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< double >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< int >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< long >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< ObjectId values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable< string >  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
BsonArray SequoiaDB.Bson.BsonArray.AddRange ( IEnumerable  values)
inline

Adds multiple elements to the array.

Parameters
valuesA list of values to add to the array.
Returns
The array (so method calls can be chained).
void SequoiaDB.Bson.BsonArray.Clear ( )
inline

Clears the array.

override BsonValue SequoiaDB.Bson.BsonArray.Clone ( )
inlinevirtual

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

Returns
A shallow clone of the array.

Reimplemented from SequoiaDB.Bson.BsonValue.

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

Compares the array to another array.

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

Compares the array to another BsonValue.

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

Implements SequoiaDB.Bson.BsonValue.

bool SequoiaDB.Bson.BsonArray.Contains ( BsonValue  value)
inline

Tests whether the array contains a value.

Parameters
valueThe value to test for.
Returns
True if the array contains the value.
void SequoiaDB.Bson.BsonArray.CopyTo ( BsonValue[]  array,
int  arrayIndex 
)
inline

Copies elements from this array to another array.

Parameters
arrayThe other array.
arrayIndexThe zero based index of the other array at which to start copying.
void SequoiaDB.Bson.BsonArray.CopyTo ( object[]  array,
int  arrayIndex 
)
inline

Copies elements from this array to another array as raw values (see BsonValue.RawValue).

Parameters
arrayThe other array.
arrayIndexThe zero based index of the other array at which to start copying.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< bool >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< BsonValue values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< DateTime >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< double >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< int >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< long >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< ObjectId values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable< string >  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static BsonArray SequoiaDB.Bson.BsonArray.Create ( IEnumerable  values)
inlinestatic

Creates a new BsonArray.

Parameters
valuesA list of values to add to the array.
Returns
A BsonArray or null.
static new BsonArray SequoiaDB.Bson.BsonArray.Create ( object  value)
inlinestatic

Creates a new BsonArray.

Parameters
valueA value to be mapped to a BsonArray.
Returns
A BsonArray or null.
override BsonValue SequoiaDB.Bson.BsonArray.DeepClone ( )
inlinevirtual

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

Returns
A deep clone of the array.

Reimplemented from SequoiaDB.Bson.BsonValue.

bool SequoiaDB.Bson.BsonArray.Equals ( BsonArray  rhs)
inline

Compares this array to another array.

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

Compares this BsonArray to another object.

Parameters
objThe other object.
Returns
True if the other object is a BsonArray and equal to this one.
IEnumerator<BsonValue> SequoiaDB.Bson.BsonArray.GetEnumerator ( )
inline

Gets an enumerator that can enumerate the elements of the array.

Returns
An enumerator.
override int SequoiaDB.Bson.BsonArray.GetHashCode ( )
inline

Gets the hash code.

Returns
The hash code.
int SequoiaDB.Bson.BsonArray.IndexOf ( BsonValue  value)
inline

Gets the index of a value in the array.

Parameters
valueThe value to search for.
Returns
The zero based index of the value (or -1 if not found).
int SequoiaDB.Bson.BsonArray.IndexOf ( BsonValue  value,
int  index 
)
inline

Gets the index of a value in the array.

Parameters
valueThe value to search for.
indexThe zero based index at which to start the search.
Returns
The zero based index of the value (or -1 if not found).
int SequoiaDB.Bson.BsonArray.IndexOf ( BsonValue  value,
int  index,
int  count 
)
inline

Gets the index of a value in the array.

Parameters
valueThe value to search for.
indexThe zero based index at which to start the search.
countThe number of elements to search.
Returns
The zero based index of the value (or -1 if not found).
void SequoiaDB.Bson.BsonArray.Insert ( int  index,
BsonValue  value 
)
inline

Inserts a new value into the array.

Parameters
indexThe zero based index at which to insert the new value.
valueThe new value.
static bool SequoiaDB.Bson.BsonArray.operator!= ( BsonArray  lhs,
BsonArray  rhs 
)
inlinestatic

Compares two BsonArray values.

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

Compares two BsonArray values.

Parameters
lhsThe first BsonArray.
rhsThe other BsonArray.
Returns
True if the two BsonArray values are equal according to ==.
static new BsonArray SequoiaDB.Bson.BsonArray.ReadFrom ( BsonReader  bsonReader)
inlinestatic

Reads a BsonArray from a BsonReader.

Parameters
bsonReaderThe reader.
Returns
A BsonArray.
bool SequoiaDB.Bson.BsonArray.Remove ( BsonValue  value)
inline

Removes the first occurrence of a value from the array.

Parameters
valueThe value to remove.
Returns
True if the value was removed.
void SequoiaDB.Bson.BsonArray.RemoveAt ( int  index)
inline

Removes an element from the array.

Parameters
indexThe zero based index of the element to remove.
BsonValue [] SequoiaDB.Bson.BsonArray.ToArray ( )
inline

Converts the BsonArray to an array of BsonValues.

Returns
An array of BsonValues.
List<BsonValue> SequoiaDB.Bson.BsonArray.ToList ( )
inline

Converts the BsonArray to a list of BsonValues.

Returns
A list of BsonValues.
override string SequoiaDB.Bson.BsonArray.ToString ( )
inline

Returns a string representation of the array.

Returns
A string representation of the array.
new void SequoiaDB.Bson.BsonArray.WriteTo ( BsonWriter  bsonWriter)
inline

Writes the array to a BsonWriter.

Parameters
bsonWriterThe writer.

Property Documentation

int SequoiaDB.Bson.BsonArray.Capacity
getset

Gets or sets the total number of elements the internal data structure can hold without resizing.

int SequoiaDB.Bson.BsonArray.Count
get

Gets the count of array elements.

bool SequoiaDB.Bson.BsonArray.IsReadOnly
get

Gets whether the array is read-only.

IEnumerable<object> SequoiaDB.Bson.BsonArray.RawValues
get

Gets the array elements as raw values (see BsonValue.RawValue).

BsonValue SequoiaDB.Bson.BsonArray.this[int index]
getset

Gets or sets an array element.

Parameters
indexThe zero based index of the element.
Returns
The value of the element.
IEnumerable<BsonValue> SequoiaDB.Bson.BsonArray.Values
get

Gets the array elements.


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