Skip to main content

A typed value that can be stored in a GenericRecord. More…

Inherits IEquatable.

​
Public Member Functions

int? AsInt ()
 Gets the value as a 32-bit integer.
 
long? AsLong ()
 Gets the value as a 64-bit integer.
 
float? AsFloat ()
 Gets the value as a 32-bit float.
 
double? AsDouble ()
 Gets the value as a 64-bit double.
 
string? AsString ()
 Gets the value as a string.
 
byte?[] AsBytes ()
 Gets the value as a byte array.
 
bool? AsBool ()
 Gets the value as a boolean (from int).
 
bool TryGetInt (out int value)
 Tries to get the value as an integer.
 
bool TryGetLong (out long value)
 Tries to get the value as a long.
 
bool TryGetFloat (out float value)
 Tries to get the value as a float.
 
bool TryGetDouble (out double value)
 Tries to get the value as a double.
 
bool TryGetString (out string? value)
 Tries to get the value as a string.
 
bool TryGetBytes (out byte[]? value)
 Tries to get the value as bytes.
 
bool TryGetBool (out bool value)
 Tries to get the value as a boolean.
 
bool Equals (RecordValue other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
override string ToString ()
 

​
Static Public Member Functions

static RecordValue Null ()
 Creates a null record value.
 
static RecordValue Int (int value)
 Creates a 32-bit integer record value.
 
static RecordValue Long (long value)
 Creates a 64-bit integer record value.
 
static RecordValue Float (float value)
 Creates a 32-bit float record value.
 
static RecordValue Double (double value)
 Creates a 64-bit double record value.
 
static RecordValue String (string value)
 Creates a string record value.
 
static RecordValue Bytes (byte[] value)
 Creates a bytes record value.
 
static RecordValue Boolean (bool value)
 Creates a boolean record value (stored as int).
 
static implicit operator RecordValue (int value)
 Implicitly converts an int value to a RecordValue.
 
static implicit operator RecordValue (long value)
 Implicitly converts a long value to a RecordValue.
 
static implicit operator RecordValue (float value)
 Implicitly converts a float value to a RecordValue.
 
static implicit operator RecordValue (double value)
 Implicitly converts a double value to a RecordValue.
 
static implicit operator RecordValue (string value)
 Implicitly converts a string value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (byte[] value)
 Implicitly converts a byte[] value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (bool value)
 Implicitly converts a bool value to a RecordValue.
 
static implicit operator RecordValue (int? value)
 Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (long? value)
 Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (float? value)
 Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (double? value)
 Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.
 
static implicit operator RecordValue (bool? value)
 Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.
 
static bool operator== (RecordValue left, RecordValue right)
 Determines whether two RecordValue instances are equal.
 
static bool operator!= (RecordValue left, RecordValue right)
 Determines whether two RecordValue instances are not equal.
 

​
Properties

RecordValueType Type [get]
 Gets the type of this record value.
 
bool IsNull [get]
 Returns true if this value is null.
 

​
Detailed Description

A typed value that can be stored in a GenericRecord.

Equivalent to Rust’s RecordValue enum.

This struct provides type-safe storage for record field values.

Definition at line 33 of file RecordValue.cs.

​
Member Function Documentation

​
◆ AsBool()

bool? kinetica.Records.RecordValue.AsBool ()
 inline

Gets the value as a boolean (from int).

Definition at line 191 of file RecordValue.cs.

​
◆ AsBytes()

byte?[] kinetica.Records.RecordValue.AsBytes ()
 inline

Gets the value as a byte array.

Definition at line 179 of file RecordValue.cs.

​
◆ AsDouble()

double? kinetica.Records.RecordValue.AsDouble ()
 inline

Gets the value as a 64-bit double.

Definition at line 154 of file RecordValue.cs.

​
◆ AsFloat()

float? kinetica.Records.RecordValue.AsFloat ()
 inline

Gets the value as a 32-bit float.

Definition at line 142 of file RecordValue.cs.

​
◆ AsInt()

int? kinetica.Records.RecordValue.AsInt ()
 inline

Gets the value as a 32-bit integer.

Definition at line 117 of file RecordValue.cs.

​
◆ AsLong()

long? kinetica.Records.RecordValue.AsLong ()
 inline

Gets the value as a 64-bit integer.

Definition at line 129 of file RecordValue.cs.

​
◆ AsString()

string? kinetica.Records.RecordValue.AsString ()
 inline

Gets the value as a string.

Definition at line 167 of file RecordValue.cs.

​
◆ Boolean()

static RecordValue kinetica.Records.RecordValue.Boolean (boolvalue)
 static

Creates a boolean record value (stored as int).

​
◆ Bytes()

static RecordValue kinetica.Records.RecordValue.Bytes (byte[]value)
 static

Creates a bytes record value.

​
◆ Double()

static RecordValue kinetica.Records.RecordValue.Double (doublevalue)
 static

Creates a 64-bit double record value.

​
◆ Equals() [1/2]

override bool kinetica.Records.RecordValue.Equals (object?obj)

​
◆ Equals() [2/2]

bool kinetica.Records.RecordValue.Equals (RecordValueother)
 inline

Definition at line 304 of file RecordValue.cs.

​
◆ Float()

static RecordValue kinetica.Records.RecordValue.Float (floatvalue)
 static

Creates a 32-bit float record value.

​
◆ GetHashCode()

override int kinetica.Records.RecordValue.GetHashCode ()
 inline

Definition at line 335 of file RecordValue.cs.

​
◆ Int()

static RecordValue kinetica.Records.RecordValue.Int (intvalue)
 static

Creates a 32-bit integer record value.

​
◆ Long()

static RecordValue kinetica.Records.RecordValue.Long (longvalue)
 static

Creates a 64-bit integer record value.

​
◆ Null()

static RecordValue kinetica.Records.RecordValue.Null ()
 static

Creates a null record value.

​
◆ operator RecordValue() [1/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (boolvalue)
 static

Implicitly converts a bool value to a RecordValue.

​
◆ operator RecordValue() [2/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (bool?value)
 static

Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [3/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (byte[]value)
 static

Implicitly converts a byte[] value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [4/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (doublevalue)
 static

Implicitly converts a double value to a RecordValue.

​
◆ operator RecordValue() [5/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (double?value)
 static

Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [6/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (floatvalue)
 static

Implicitly converts a float value to a RecordValue.

​
◆ operator RecordValue() [7/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (float?value)
 static

Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [8/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (intvalue)
 static

Implicitly converts an int value to a RecordValue.

​
◆ operator RecordValue() [9/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (int?value)
 static

Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [10/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (longvalue)
 static

Implicitly converts a long value to a RecordValue.

​
◆ operator RecordValue() [11/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (long?value)
 static

Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.

​
◆ operator RecordValue() [12/12]

static implicit kinetica.Records.RecordValue.operator RecordValue (stringvalue)
 static

Implicitly converts a string value to a RecordValue. A null input becomes a null record value.

​
◆ operator!=()

static bool kinetica.Records.RecordValue.operator!= (RecordValueleft,
RecordValueright )
 static

Determines whether two RecordValue instances are not equal.

​
◆ operator==()

static bool kinetica.Records.RecordValue.operator== (RecordValueleft,
RecordValueright )
 static

Determines whether two RecordValue instances are equal.

​
◆ String()

static RecordValue kinetica.Records.RecordValue.String (stringvalue)
 static

Creates a string record value.

​
◆ ToString()

override string kinetica.Records.RecordValue.ToString ()
 inline

Definition at line 356 of file RecordValue.cs.

​
◆ TryGetBool()

bool kinetica.Records.RecordValue.TryGetBool (out boolvalue)
 inline

Tries to get the value as a boolean.

Definition at line 288 of file RecordValue.cs.

​
◆ TryGetBytes()

bool kinetica.Records.RecordValue.TryGetBytes (out byte?[]value)
 inline

Tries to get the value as bytes.

Definition at line 271 of file RecordValue.cs.

​
◆ TryGetDouble()

bool kinetica.Records.RecordValue.TryGetDouble (out doublevalue)
 inline

Tries to get the value as a double.

Definition at line 242 of file RecordValue.cs.

​
◆ TryGetFloat()

bool kinetica.Records.RecordValue.TryGetFloat (out floatvalue)
 inline

Tries to get the value as a float.

Definition at line 230 of file RecordValue.cs.

​
◆ TryGetInt()

bool kinetica.Records.RecordValue.TryGetInt (out intvalue)
 inline

Tries to get the value as an integer.

Definition at line 206 of file RecordValue.cs.

​
◆ TryGetLong()

bool kinetica.Records.RecordValue.TryGetLong (out longvalue)
 inline

Tries to get the value as a long.

Definition at line 218 of file RecordValue.cs.

​
◆ TryGetString()

bool kinetica.Records.RecordValue.TryGetString (out string?value)
 inline

Tries to get the value as a string.

Definition at line 254 of file RecordValue.cs.

​
Property Documentation

​
◆ IsNull

bool kinetica.Records.RecordValue.IsNull
 get

Returns true if this value is null.

Definition at line 52 of file RecordValue.cs.

​
◆ Type

RecordValueType kinetica.Records.RecordValue.Type
 get

Gets the type of this record value.

Definition at line 49 of file RecordValue.cs.

The documentation for this struct was generated from the following file: