Grijjy FoundationUnits Class Hierarchy Classes, Interfaces, Objects and Records Types Variables Constants Functions and Procedures Identifiers |
Interface IgoBsonBaseReader
Unit
Grijjy.Bson.IO
Declaration
type IgoBsonBaseReader = interface(IInterface)
Description
Base interface for IgoBsonReader, IgoJsonReader and IgoBsonDocumentReader
Attributes
- GUID['{A0592C3C-5E24-4424-9662-EA7F33BB1B9A}']
Hierarchy
- IInterface
- IgoBsonBaseReader
Overview
Methods
Properties
Description
Methods
 |
function EndOfStream: Boolean; |
|
Whether the reader is at the end of the stream.
Returns
True if at end of stream |
|
function GetCurrentBsonType: TgoBsonType; |
|
Gets the current BSON type in the stream.
Note: calls ReadBsonType if necessary.
Returns
The current BSON type. |
|
procedure ReturnToBookmark(const ABookmark: IgoBsonReaderBookmark); |
|
Returns the reader to previously bookmarked position and state.
AParameters: ABookmark: the bookmark to return to. This value has previously been acquired using GetBookmark.
|
|
function ReadDocument: TgoBsonDocument; |
|
Reads a BSON Document from the stream.
Returns
The read BSON Document. Exceptions raised
An- exception if the current position in the stream does not contain a BSON Document, or the stream is invalid.
|
|
function ReadArray: TgoBsonArray; |
|
Reads a BSON Array from the stream.
Returns
The read BSON Array. Exceptions raised
An- exception if the current position in the stream does not contain a BSON Array, or the stream is invalid.
|
|
function ReadValue: TgoBsonValue; |
|
Reads a BSON value from the stream.
Returns
The read BSON value. Exceptions raised
An- exception if the current position in the stream does not contain a BSON value, or the stream is invalid.
|
|
function ReadBinaryData: TgoBsonBinaryData; |
|
Reads a BSON Binary from the stream.
Returns
The read BSON Binary. Exceptions raised
An- exception if the current position in the stream does not contain a BSON Binary, or the stream is invalid.
|
|
function ReadRegularExpression: TgoBsonRegularExpression; |
|
Reads a BSON Regular Expression from the stream.
Returns
The read BSON Regular Expression. Exceptions raised
An- exception if the current position in the stream does not contain a BSON Regular Expression, or the stream is invalid.
|
|
function ReadBsonType: TgoBsonType; |
|
Reads a BSON type from the stream.
Returns
The read BSON type. Exceptions raised
An- exception if the current position in the stream does not contain a BSON type, or the stream is invalid.
|
|
function ReadName: String; |
|
Reads the name of an element from the stream.
Returns
The read element name. Exceptions raised
An- exception if the current position in the stream does not contain an element name, or the stream is invalid.
|
|
procedure SkipName; |
|
Skips the name of an element.
Exceptions raised
An- exception if the current position in the stream does not contain an element name, or the stream is invalid.
|
|
procedure SkipValue; |
|
Skips the value of an element.
Exceptions raised
An- exception if the current position in the stream does not contain an element value, or the stream is invalid.
|
|
function ReadBoolean: Boolean; |
|
Reads a Boolean value from the stream.
Returns
The read Boolean value. Exceptions raised
An- exception if the current position in the stream does not contain a Boolean value, or the stream is invalid.
|
|
function ReadInt32: Integer; |
|
Reads a 32-bit Integer value from the stream.
Returns
The read Integer value. Exceptions raised
An- exception if the current position in the stream does not contain a 32-bit Integer value, or the stream is invalid.
|
|
function ReadInt64: Int64; |
|
Reads a 64-bit Integer value from the stream.
Returns
The read Integer value. Exceptions raised
An- exception if the current position in the stream does not contain a 64-bit Integer value, or the stream is invalid.
|
|
function ReadDouble: Double; |
|
Reads a Double value from the stream.
Returns
The read Double value. Exceptions raised
An- exception if the current position in the stream does not contain a Double value, or the stream is invalid.
|
|
function ReadString: String; |
|
Reads a String value from the stream.
Returns
The read String value. Exceptions raised
An- exception if the current position in the stream does not contain a String value, or the stream is invalid.
|
|
function ReadDateTime: Int64; |
|
Reads a DateTime value from the stream.
Returns
The read DateTime value as the number of UTC milliseconds since the Unix epoch. Exceptions raised
An- exception if the current position in the stream does not contain a DateTime value, or the stream is invalid.
|
|
function ReadTimestamp: Int64; |
|
Reads a Timestamp value from the stream.
Returns
The read Timestamp value. Exceptions raised
An- exception if the current position in the stream does not contain a Timestamp value, or the stream is invalid.
|
|
function ReadObjectId: TgoObjectId; |
|
Reads an ObjectId value from the stream.
Returns
The read ObjectId value. Exceptions raised
An- exception if the current position in the stream does not contain a ObjectId value, or the stream is invalid.
|
|
function ReadBytes: TBytes; |
|
Reads a Binary value from the stream as a byte array.
Returns
The read Binary value. Exceptions raised
An- exception if the current position in the stream does not contain a BSON Binary, or the stream is invalid.
|
|
function ReadJavaScript: String; |
|
Reads a JavaScript from the stream.
Returns
The read JavaScript. Exceptions raised
An- exception if the current position in the stream does not contain a JavaScript, or the stream is invalid.
|
|
function ReadJavaScriptWithScope: String; |
|
Reads a JavaScript with scope from the stream.
Note: call ReadStartDocument next to read the scope.
Returns
The read JavaScript. Exceptions raised
An- exception if the current position in the stream does not contain a JavaScript with Scope, or the stream is invalid.
|
|
procedure ReadNull; |
|
Reads a BSON Null value from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain a Null value, or the stream is invalid.
|
|
procedure ReadUndefined; |
|
Reads a BSON Undefined value from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain a Undefined value, or the stream is invalid.
|
|
procedure ReadMaxKey; |
|
Reads a BSON MaxKey value from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain a MaxKey value, or the stream is invalid.
|
|
procedure ReadMinKey; |
|
Reads a BSON MinKey value from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain a MinKey value, or the stream is invalid.
|
|
function ReadSymbol: String; |
|
Reads a BSON Symbol from the stream.
Returns
The read Symbol name. Exceptions raised
An- exception if the current position in the stream does not contain a Symbol, or the stream is invalid.
|
|
procedure ReadStartArray; |
|
Reads the start of a BSON Array from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain the start of a BSON Array, or the stream is invalid.
|
|
procedure ReadEndArray; |
|
Reads the end of a BSON Array from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain the end of a BSON Array, or the stream is invalid.
|
|
procedure ReadStartDocument; |
|
Reads the start of a BSON Document from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain the start of a BSON Document, or the stream is invalid.
|
|
procedure ReadEndDocument; |
|
Reads the end of a BSON Document from the stream.
Exceptions raised
An- exception if the current position in the stream does not contain the end of a BSON Document, or the stream is invalid.
|
Properties
Generated by P2PasDoc 0.13.0 on 2017-04-25 12:54:26
|