Struct finalfusion::metadata::Metadata

pub struct Metadata { /* fields omitted */ }

Embeddings metadata.

finalfusion metadata in TOML format.

Methods

impl Metadata

pub fn new(data: Value) -> Self

Construct new Metadata.

Methods from Deref<Target = Value>

pub fn get<I>(&self, index: I) -> Option<&Value> where
    I: Index, 

Index into a TOML array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None if the type of self does not match the type of the index, for example if the index is a string and self is an array or a number. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the array.

pub fn get_mut<I>(&mut self, index: I) -> Option<&mut Value> where
    I: Index, 

Mutably index into a TOML array or map. A string index can be used to access a value in a map, and a usize index can be used to access an element of an array.

Returns None if the type of self does not match the type of the index, for example if the index is a string and self is an array or a number. Also returns None if the given key does not exist in the map or the given index is not within the bounds of the array.

pub fn as_integer(&self) -> Option<i64>

Extracts the integer value if it is an integer.

pub fn is_integer(&self) -> bool

Tests whether this value is an integer.

pub fn as_float(&self) -> Option<f64>

Extracts the float value if it is a float.

pub fn is_float(&self) -> bool

Tests whether this value is a float.

pub fn as_bool(&self) -> Option<bool>

Extracts the boolean value if it is a boolean.

pub fn is_bool(&self) -> bool

Tests whether this value is a boolean.

pub fn as_str(&self) -> Option<&str>

Extracts the string of this value if it is a string.

pub fn is_str(&self) -> bool

Tests if this value is a string.

pub fn as_datetime(&self) -> Option<&Datetime>

Extracts the datetime value if it is a datetime.

Note that a parsed TOML value will only contain ISO 8601 dates. An example date is:

1979-05-27T07:32:00Z

pub fn is_datetime(&self) -> bool

Tests whether this value is a datetime.

pub fn as_array(&self) -> Option<&Vec<Value>>

Extracts the array value if it is an array.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

Extracts the array value if it is an array.

pub fn is_array(&self) -> bool

Tests whether this value is an array.

pub fn as_table(&self) -> Option<&Map<String, Value>>

Extracts the table value if it is a table.

pub fn as_table_mut(&mut self) -> Option<&mut Map<String, Value>>

Extracts the table value if it is a table.

pub fn is_table(&self) -> bool

Tests whether this value is a table.

pub fn same_type(&self, other: &Value) -> bool

Tests whether this and another value have the same type.

pub fn type_str(&self) -> &'static str

Returns a human-readable representation of the type of this value.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Deref for Metadata

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Metadata

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Value> for Metadata

fn from(value: Value) -> Self

Performs the conversion.

impl PartialEq<Metadata> for Metadata

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

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

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

This method tests for !=.

impl StructuralPartialEq for Metadata