Struct surrealml_core::storage::header::keys::KeyBindings

pub struct KeyBindings {
    pub store: Vec<String>,
    pub reference: HashMap<String, usize>,
}

Defines the key bindings for input data.

Fields

• store - A vector of strings that represent the column names. The order of this store is the same as the order in which the columns are expected in the input data.
• reference - A hashmap that maps the column names to their index in the self.store field.

Fields

store: Vec<String>

reference: HashMap<String, usize>

Implementations

impl KeyBindings

pub fn fresh() -> Self

Creates a new key bindings with no columns.

Returns

A new key bindings with no columns.

pub fn add_column(&mut self, column_name: String)

Adds a column name to the self.store field. It must be noted that the order in which the columns are added is the order in which they will be expected in the input data.

Arguments

• column_name - The name of the column to be added.

pub fn from_string(data: String) -> Self

Constructs the key bindings from a string.

Arguments

• data - The string to be converted into key bindings.

Returns

The key bindings constructed from the string.

pub fn to_string(&self) -> String

converts the key bindings to a string.

Returns

The key bindings as a string.

pub fn from_bytes(data: &[u8]) -> Result<Self, SurrealError>

Constructs the key bindings from bytes.

Arguments

• data - The bytes to be converted into key bindings.

Returns

The key bindings constructed from the bytes.

pub fn to_bytes(&self) -> Vec<u8>

Converts the key bindings to bytes.

Returns

The key bindings as bytes.

Trait Implementations

impl Debug for KeyBindings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KeyBindings

fn eq(&self, other: &KeyBindings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KeyBindings