Grijjy Foundation

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Interface IgoBsonBaseWriter

DescriptionHierarchyFieldsMethodsProperties

Unit

Grijjy.Bson.IO

Declaration

type IgoBsonBaseWriter = interface(IInterface)

Description

Base interface for IgoBsonWriter, IgoJsonWriter and IgoBsonDocumentWriter

Attributes
GUID['{4525DC0D-C54E-47B2-85BE-4C09A8F5DF54}']

Hierarchy

  • IInterface
  • IgoBsonBaseWriter

Overview

Methods

Public function GetState: TgoBsonWriterState;
Public procedure WriteValue(const AValue: TgoBsonValue);
Public procedure WriteBinaryData(const AValue: TgoBsonBinaryData);
Public procedure WriteRegularExpression(const AValue: TgoBsonRegularExpression); overload;
Public procedure WriteRegularExpression(const AName: String; const AValue: TgoBsonRegularExpression); overload;
Public procedure WriteName(const AName: String);
Public procedure WriteBoolean(const AValue: Boolean); overload;
Public procedure WriteBoolean(const AName: String; const AValue: Boolean); overload;
Public procedure WriteInt32(const AValue: Integer); overload;
Public procedure WriteInt32(const AName: String; const AValue: Integer); overload;
Public procedure WriteInt64(const AValue: Int64); overload;
Public procedure WriteInt64(const AName: String; const AValue: Int64); overload;
Public procedure WriteDouble(const AValue: Double); overload;
Public procedure WriteDouble(const AName: String; const AValue: Double); overload;
Public procedure WriteString(const AValue: String); overload;
Public procedure WriteString(const AName, AValue: String); overload;
Public procedure WriteDateTime(const AMillisecondsSinceEpoch: Int64); overload;
Public procedure WriteDateTime(const AName: String; const AMillisecondsSinceEpoch: Int64); overload;
Public procedure WriteBytes(const AValue: TBytes); overload;
Public procedure WriteBytes(const AName: String; const AValue: TBytes); overload;
Public procedure WriteTimestamp(const AValue: Int64); overload;
Public procedure WriteTimestamp(const AName: String; const AValue: Int64); overload;
Public procedure WriteObjectId(const AValue: TgoObjectId); overload;
Public procedure WriteObjectId(const AName: String; const AValue: TgoObjectId); overload;
Public procedure WriteJavaScript(const ACode: String); overload;
Public procedure WriteJavaScript(const AName, ACode: String); overload;
Public procedure WriteJavaScriptWithScope(const ACode: String); overload;
Public procedure WriteJavaScriptWithScope(const AName, ACode: String); overload;
Public procedure WriteNull; overload;
Public procedure WriteNull(const AName: String); overload;
Public procedure WriteUndefined; overload;
Public procedure WriteUndefined(const AName: String); overload;
Public procedure WriteMaxKey; overload;
Public procedure WriteMaxKey(const AName: String); overload;
Public procedure WriteMinKey; overload;
Public procedure WriteMinKey(const AName: String); overload;
Public procedure WriteSymbol(const AValue: String); overload;
Public procedure WriteSymbol(const AName, AValue: String); overload;
Public procedure WriteStartArray; overload;
Public procedure WriteStartArray(const AName: String); overload;
Public procedure WriteEndArray;
Public procedure WriteStartDocument; overload;
Public procedure WriteStartDocument(const AName: String); overload;
Public procedure WriteEndDocument;

Properties

Public property State: TgoBsonWriterState read GetState;

Description

Methods

Public function GetState: TgoBsonWriterState;
 
Public procedure WriteValue(const AValue: TgoBsonValue);

Writes a BSON value.

Parameters
AValue
the BSON value to write.
Exceptions raised
EArgumentNilException
if AValue has not been assigned (IsNil returns True).
Public procedure WriteBinaryData(const AValue: TgoBsonBinaryData);

Writes a BSON binary.

Parameters
AValue
the BSON binary to write.
Exceptions raised
EArgumentNilException
if AValue has not been assigned (IsNil returns True).
Public procedure WriteRegularExpression(const AValue: TgoBsonRegularExpression); overload;

Writes a BSON Regular Expression.

Parameters
AValue
the BSON Regular Expression to write.
Exceptions raised
EArgumentNilException
if AValue has not been assigned (IsNil returns True).
Public procedure WriteRegularExpression(const AName: String; const AValue: TgoBsonRegularExpression); overload;

Writes both an element name and a BSON Regular Expression.

Parameters
AName
the element name.
AValue
the BSON Regular Expression to write.
Exceptions raised
EArgumentNilException
if AValue has not been assigned (IsNil returns True).
Public procedure WriteName(const AName: String);

Writes the name of an element.

Parameters
AName
the element name.
Public procedure WriteBoolean(const AValue: Boolean); overload;

Writes a Boolean value.

Parameters
AValue
the Boolean value.
Public procedure WriteBoolean(const AName: String; const AValue: Boolean); overload;

Writes a name/value pair with a Boolean value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the Boolean value.
Public procedure WriteInt32(const AValue: Integer); overload;

Writes a 32-bit Integer value.

Parameters
AValue
the Integer value.
Public procedure WriteInt32(const AName: String; const AValue: Integer); overload;

Writes a name/value pair with a 32-bit Integer value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the Integer value.
Public procedure WriteInt64(const AValue: Int64); overload;

Writes a 64-bit Integer value.

Parameters
AValue
the Integer value.
Public procedure WriteInt64(const AName: String; const AValue: Int64); overload;

Writes a name/value pair with a 64-bit Integer value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the Integer value.
Public procedure WriteDouble(const AValue: Double); overload;

Writes a Double value.

Parameters
AValue
the Double value.
Public procedure WriteDouble(const AName: String; const AValue: Double); overload;

Writes a name/value pair with a Double value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the Double value.
Public procedure WriteString(const AValue: String); overload;

Writes a String value.

Parameters
AValue
the String value.
Public procedure WriteString(const AName, AValue: String); overload;

Writes a name/value pair with a String value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the String value.
Public procedure WriteDateTime(const AMillisecondsSinceEpoch: Int64); overload;

Writes a DateTime value.

Parameters
AMillisecondsSinceEpoch
the number of UTC milliseconds since the Unix epoch
Public procedure WriteDateTime(const AName: String; const AMillisecondsSinceEpoch: Int64); overload;

Writes a name/value pair with a DateTime value. Can only be used when inside a document.

Parameters
AName
the element name.
AMillisecondsSinceEpoch
the number of UTC milliseconds since the Unix epoch
Public procedure WriteBytes(const AValue: TBytes); overload;

Writes a byte array as binary data of sub type Binary

Parameters
ABytes
the bytes to write
Public procedure WriteBytes(const AName: String; const AValue: TBytes); overload;

Writes a name/value pair with binary date. Can only be used when inside a document.

Parameters
AName
the element name.
ABytes
the bytes to write
Public procedure WriteTimestamp(const AValue: Int64); overload;

Writes a Timestamp value.

Parameters
AValue
the Timestamp value.
Public procedure WriteTimestamp(const AName: String; const AValue: Int64); overload;

Writes a name/value pair with a Timestamp value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the Timestamp value.
Public procedure WriteObjectId(const AValue: TgoObjectId); overload;

Writes an ObjectId value.

Parameters
AValue
the ObjectId value.
Public procedure WriteObjectId(const AName: String; const AValue: TgoObjectId); overload;

Writes a name/value pair with an ObjectId value. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the ObjectId value.
Public procedure WriteJavaScript(const ACode: String); overload;

Writes a JavaScript.

Parameters
ACode
the JavaScript code.
Public procedure WriteJavaScript(const AName, ACode: String); overload;

Writes a name/value pair with a JavaScript. Can only be used when inside a document.

Parameters
AName
the element name.
ACode
the JavaScript code.
Public procedure WriteJavaScriptWithScope(const ACode: String); overload;

Writes a JavaScript with scope.

Note: call WriteStartDocument to start writing the scope.

Parameters
ACode
the JavaScript code.
Public procedure WriteJavaScriptWithScope(const AName, ACode: String); overload;

Writes a name/value pair with a JavaScript with scope. Can only be used when inside a document.

Note: call WriteStartDocument to start writing the scope.

Parameters
AName
the element name.
ACode
the JavaScript code.
Public procedure WriteNull; overload;

Writes a BSON Null value

Public procedure WriteNull(const AName: String); overload;

Writes a name/value pair with a BSON Null value. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteUndefined; overload;

Writes a BSON Undefined value.

Public procedure WriteUndefined(const AName: String); overload;

Writes a name/value pair with a BSON Undefined value. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteMaxKey; overload;

Writes a BSON MaxKey value

Public procedure WriteMaxKey(const AName: String); overload;

Writes a name/value pair with a BSON MaxKey value. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteMinKey; overload;

Writes a BSON MinKey value

Public procedure WriteMinKey(const AName: String); overload;

Writes a name/value pair with a BSON MinKey value. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteSymbol(const AValue: String); overload;

Writes a BSON Symbol.

Parameters
AValue
the symbol.
Public procedure WriteSymbol(const AName, AValue: String); overload;

Writes a name/value pair with a BSON Symbol. Can only be used when inside a document.

Parameters
AName
the element name.
AValue
the symbol.
Public procedure WriteStartArray; overload;

Writes the start of a BSON Array

Public procedure WriteStartArray(const AName: String); overload;

Writes a name/value pair, where the value starts a BSON Array. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteEndArray;

Writes the end of a BSON Array

Public procedure WriteStartDocument; overload;

Writes the start of a BSON Document

Public procedure WriteStartDocument(const AName: String); overload;

Writes a name/value pair, where the value starts a BSON Document. Can only be used when inside a document.

Parameters
AName
the element name.
Public procedure WriteEndDocument;

Writes the end of a BSON Document

Properties

Public property State: TgoBsonWriterState read GetState;

The current state of the writer

Generated by P2PasDoc 0.13.0 on 2017-04-25 12:54:26