record TgoBsonElement

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TgoBsonElement = record

Description

An element in a TgoBsonDocument

Overview

Methods

class function Create(const AName: String; const AValue: TgoBsonValue): TgoBsonElement; static;
class operator Equal(const A, B: TgoBsonElement): Boolean; static;
class operator NotEqual(const A, B: TgoBsonElement): Boolean; inline; static;
function Clone: TgoBsonElement;
function DeepClone: TgoBsonElement;

Properties

property Name: String read FName;
property Value: TgoBsonValue read GetValue;

Description

Methods

class function Create(const AName: String; const AValue: TgoBsonValue): TgoBsonElement; static;

Creates a document element.

Parameters
AName
the name of the element.
AValue
the value of the element.
Exceptions raised
EArgumentNilException
if AValue has not been assigned (if IsNil returns True).
class operator Equal(const A, B: TgoBsonElement): Boolean; static;

Tests 2 document elements for equality. Elements are equal if both their names (case-sensitive) and values are equal.

class operator NotEqual(const A, B: TgoBsonElement): Boolean; inline; static;

Tests 2 document elements for inequality.

function Clone: TgoBsonElement;

Creates a shallow clone of the element. The returned element will contain a reference to the existing value.

Returns

The clone

function DeepClone: TgoBsonElement;

Creates a deep clone of the element. The returned element will contain a deep clone of the existing value.

Returns

The deep clone

Properties

property Name: String read FName;

Name of the element

property Value: TgoBsonValue read GetValue;

Value of the element


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