| BsonDocumentReader Class |
Represents a BSON reader for a BsonDocument.
Inheritance HierarchyNamespace: MongoDB.Bson.IO
Assembly: MongoDB.Bson (in MongoDB.Bson.dll) Version: 2.4.1
SyntaxThe BsonDocumentReader type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BsonDocumentReader(BsonDocument) |
Initializes a new instance of the BsonDocumentReader class.
|
| BsonDocumentReader(BsonDocument, BsonDocumentReaderSettings) |
Initializes a new instance of the BsonDocumentReader class.
|
Methods| Name | Description | |
|---|---|---|
| Close |
Closes the reader.
(Overrides BsonReaderClose.) |
| Dispose |
Disposes of any resources used by the reader.
(Inherited from BsonReader.) |
 | Dispose(Boolean) |
Disposes of any resources used by the reader.
(Overrides BsonReaderDispose(Boolean).) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBookmark |
Gets a bookmark to the reader's current position and state.
(Overrides BsonReaderGetBookmark.) |
| GetCurrentBsonType |
Gets the current BsonType (calls ReadBsonType if necessary).
(Inherited from BsonReader.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsAtEndOfFile |
Determines whether this reader is at end of file.
(Overrides BsonReaderIsAtEndOfFile.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadBinaryData |
Reads BSON binary data from the reader.
(Overrides BsonReaderReadBinaryData.) |
| ReadBoolean |
Reads a BSON boolean from the reader.
(Overrides BsonReaderReadBoolean.) |
| ReadBsonType |
Reads a BsonType from the reader.
(Overrides BsonReaderReadBsonType.) |
| ReadBytes |
Reads BSON binary data from the reader.
(Overrides BsonReaderReadBytes.) |
| ReadDateTime |
Reads a BSON DateTime from the reader.
(Overrides BsonReaderReadDateTime.) |
| ReadDecimal128 |
Reads a BSON Decimal128 from the reader.
(Overrides BsonReaderReadDecimal128.) |
| ReadDouble |
Reads a BSON Double from the reader.
(Overrides BsonReaderReadDouble.) |
| ReadEndArray |
Reads the end of a BSON array from the reader.
(Overrides BsonReaderReadEndArray.) |
| ReadEndDocument |
Reads the end of a BSON document from the reader.
(Overrides BsonReaderReadEndDocument.) |
| ReadInt32 |
Reads a BSON Int32 from the reader.
(Overrides BsonReaderReadInt32.) |
| ReadInt64 |
Reads a BSON Int64 from the reader.
(Overrides BsonReaderReadInt64.) |
| ReadJavaScript |
Reads a BSON JavaScript from the reader.
(Overrides BsonReaderReadJavaScript.) |
| ReadJavaScriptWithScope |
Reads a BSON JavaScript with scope from the reader (call ReadStartDocument next to read the scope).
(Overrides BsonReaderReadJavaScriptWithScope.) |
| ReadMaxKey |
Reads a BSON MaxKey from the reader.
(Overrides BsonReaderReadMaxKey.) |
| ReadMinKey |
Reads a BSON MinKey from the reader.
(Overrides BsonReaderReadMinKey.) |
| ReadName |
Reads the name of an element from the reader.
(Inherited from BsonReader.) |
| ReadName(INameDecoder) |
Reads the name of an element from the reader.
(Overrides BsonReaderReadName(INameDecoder).) |
| ReadNull |
Reads a BSON null from the reader.
(Overrides BsonReaderReadNull.) |
| ReadObjectId |
Reads a BSON ObjectId from the reader.
(Overrides BsonReaderReadObjectId.) |
| ReadRawBsonArray |
Reads a raw BSON array.
(Inherited from BsonReader.) |
| ReadRawBsonDocument |
Reads a raw BSON document.
(Inherited from BsonReader.) |
| ReadRegularExpression |
Reads a BSON regular expression from the reader.
(Overrides BsonReaderReadRegularExpression.) |
| ReadStartArray |
Reads the start of a BSON array.
(Overrides BsonReaderReadStartArray.) |
| ReadStartDocument |
Reads the start of a BSON document.
(Overrides BsonReaderReadStartDocument.) |
| ReadString |
Reads a BSON string from the reader.
(Overrides BsonReaderReadString.) |
| ReadSymbol |
Reads a BSON symbol from the reader.
(Overrides BsonReaderReadSymbol.) |
| ReadTimestamp |
Reads a BSON timestamp from the reader.
(Overrides BsonReaderReadTimestamp.) |
| ReadUndefined |
Reads a BSON undefined from the reader.
(Overrides BsonReaderReadUndefined.) |
| ReturnToBookmark |
Returns the reader to previously bookmarked position and state.
(Overrides BsonReaderReturnToBookmark(BsonReaderBookmark).) |
| SkipName |
Skips the name (reader must be positioned on a name).
(Overrides BsonReaderSkipName.) |
| SkipValue |
Skips the value (reader must be positioned on a value).
(Overrides BsonReaderSkipValue.) |
| ThrowInvalidContextType |
Throws an InvalidOperationException when the method called is not valid for the current ContextType.
(Inherited from BsonReader.) |
| ThrowInvalidState |
Throws an InvalidOperationException when the method called is not valid for the current state.
(Inherited from BsonReader.) |
| ThrowObjectDisposedException |
Throws an ObjectDisposedException.
(Inherited from BsonReader.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| VerifyBsonType |
Verifies the current state and BsonType of the reader.
(Inherited from BsonReader.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToBson |
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.) |
| ToBsonDocument |
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.) |
| ToJson |
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.) |
Properties| Name | Description | |
|---|---|---|
 | CurrentBsonType |
Gets the current BsonType.
(Inherited from BsonReader.) |
 | CurrentName |
Gets the current name.
(Inherited from BsonReader.) |
| Disposed |
Gets whether the BsonReader has been disposed.
(Inherited from BsonReader.) |
| Settings |
Gets the settings of the reader.
(Inherited from BsonReader.) |
| State |
Gets the current state of the reader.
(Inherited from BsonReader.) |
See Also