Class BsonBoolean
Represents a BSON boolean value.
[Serializable]
public class BsonBoolean : BsonValue, IComparable<BsonValue>, IConvertible, IEquatable<BsonValue>, IComparable<BsonBoolean>, IEquatable<BsonBoolean>- Inheritance
-
BsonBoolean
- Implements
- Inherited Members
- Extension Methods
Constructors
BsonBoolean(bool)
Initializes a new instance of the BsonBoolean class.
public BsonBoolean(bool value)Parameters
valueboolThe value.
Properties
BsonType
Gets the BsonType of this BsonValue.
public override BsonType BsonType { get; }Property Value
False
Gets the instance of BsonBoolean that represents false.
public static BsonBoolean False { get; }Property Value
RawValue
Gets the BsonBoolean as a bool.
[Obsolete("Use Value instead.")]
public override object RawValue { get; }Property Value
True
Gets the instance of BsonBoolean that represents true.
public static BsonBoolean True { get; }Property Value
Value
Gets the value of this BsonBoolean.
public bool Value { get; }Property Value
Methods
CompareTo(BsonBoolean)
Compares this BsonBoolean to another BsonBoolean.
public int CompareTo(BsonBoolean other)Parameters
otherBsonBooleanThe other BsonBoolean.
Returns
- int
A 32-bit signed integer that indicates whether this BsonBoolean is less than, equal to, or greather than the other.
CompareTo(BsonValue)
Compares the BsonBoolean to another BsonValue.
public override int CompareTo(BsonValue other)Parameters
otherBsonValueThe other BsonValue.
Returns
- int
A 32-bit signed integer that indicates whether this BsonBoolean is less than, equal to, or greather than the other BsonValue.
Create(object)
Returns one of the two possible BsonBoolean values.
public static BsonBoolean Create(object value)Parameters
valueobjectAn object to be mapped to a BsonBoolean.
Returns
- BsonBoolean
A BsonBoolean or null.
Equals(BsonBoolean)
Compares this BsonBoolean to another BsonBoolean.
public bool Equals(BsonBoolean rhs)Parameters
rhsBsonBooleanThe other BsonBoolean.
Returns
- bool
True if the two BsonBoolean values are equal.
Equals(object)
Compares this BsonBoolean to another object.
public override bool Equals(object obj)Parameters
objobjectThe other object.
Returns
- bool
True if the other object is a BsonBoolean and equal to this one.
GetHashCode()
Gets the hash code.
public override int GetHashCode()Returns
- int
The hash code.
IConvertibleGetTypeCodeImplementation()
Implementation of the IConvertible GetTypeCode method.
protected override TypeCode IConvertibleGetTypeCodeImplementation()Returns
- TypeCode
The TypeCode.
IConvertibleToBooleanImplementation(IFormatProvider)
Implementation of the IConvertible ToBoolean method.
protected override bool IConvertibleToBooleanImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- bool
A bool.
IConvertibleToByteImplementation(IFormatProvider)
Implementation of the IConvertible ToByte method.
protected override byte IConvertibleToByteImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- byte
A byte.
IConvertibleToDecimalImplementation(IFormatProvider)
Implementation of the IConvertible ToDecimal method.
protected override decimal IConvertibleToDecimalImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- decimal
A decimal.
IConvertibleToDoubleImplementation(IFormatProvider)
Implementation of the IConvertible ToDouble method.
protected override double IConvertibleToDoubleImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- double
A double.
IConvertibleToInt16Implementation(IFormatProvider)
Implementation of the IConvertible ToInt16 method.
protected override short IConvertibleToInt16Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- short
A short.
IConvertibleToInt32Implementation(IFormatProvider)
Implementation of the IConvertible ToInt32 method.
protected override int IConvertibleToInt32Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- int
An int.
IConvertibleToInt64Implementation(IFormatProvider)
Implementation of the IConvertible ToInt64 method.
protected override long IConvertibleToInt64Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- long
A long.
IConvertibleToSByteImplementation(IFormatProvider)
Implementation of the IConvertible ToSByte method.
protected override sbyte IConvertibleToSByteImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- sbyte
An sbyte.
IConvertibleToSingleImplementation(IFormatProvider)
Implementation of the IConvertible ToSingle method.
protected override float IConvertibleToSingleImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- float
A float.
IConvertibleToStringImplementation(IFormatProvider)
Implementation of the IConvertible ToString method.
protected override string IConvertibleToStringImplementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- string
A string.
IConvertibleToUInt16Implementation(IFormatProvider)
Implementation of the IConvertible ToUInt16 method.
protected override ushort IConvertibleToUInt16Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- ushort
A ushort.
IConvertibleToUInt32Implementation(IFormatProvider)
Implementation of the IConvertible ToUInt32 method.
protected override uint IConvertibleToUInt32Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- uint
A uint.
IConvertibleToUInt64Implementation(IFormatProvider)
Implementation of the IConvertible ToUInt64 method.
protected override ulong IConvertibleToUInt64Implementation(IFormatProvider provider)Parameters
providerIFormatProviderThe format provider.
Returns
- ulong
A ulong.
ToBoolean()
Converts this BsonValue to a Boolean (using the JavaScript definition of truthiness).
public override bool ToBoolean()Returns
- bool
A Boolean.
ToString()
Returns a string representation of the value.
public override string ToString()Returns
- string
A string representation of the value.
Operators
operator ==(BsonBoolean, BsonBoolean)
Compares two BsonBoolean values.
public static bool operator ==(BsonBoolean lhs, BsonBoolean rhs)Parameters
lhsBsonBooleanThe first BsonBoolean.
rhsBsonBooleanThe other BsonBoolean.
Returns
- bool
True if the two BsonBoolean values are equal according to ==.
implicit operator BsonBoolean(bool)
Converts a bool to a BsonBoolean.
public static implicit operator BsonBoolean(bool value)Parameters
valueboolA bool.
Returns
- BsonBoolean
A BsonBoolean.
operator !=(BsonBoolean, BsonBoolean)
Compares two BsonBoolean values.
public static bool operator !=(BsonBoolean lhs, BsonBoolean rhs)Parameters
lhsBsonBooleanThe first BsonBoolean.
rhsBsonBooleanThe other BsonBoolean.
Returns
- bool
True if the two BsonBoolean values are not equal according to ==.