MetadataValue

Enum MetadataValue 

Source
pub enum MetadataValue {
    String(String),
    Integer(i64),
    Float(f64),
    Boolean(bool),
    StringArray(Vec<String>),
}
Expand description

Supported metadata value types.

EdgeVec metadata supports 5 value types optimized for common RAG and vector search use cases.

§Type Mapping

Rust TypeJSON TypeTypeScript Type
Stringstringstring
Integernumbernumber
Floatnumbernumber
Booleanbooleanboolean
StringArraystring[]string[]

§Serialization

Uses adjacently-tagged representation for unambiguous type preservation:

use edgevec::metadata::MetadataValue;

let value = MetadataValue::Integer(42);
let json = serde_json::to_string(&value).unwrap();
assert_eq!(json, r#"{"type":"integer","value":42}"#);

§Example

use edgevec::metadata::MetadataValue;

let title = MetadataValue::String("Document Title".to_string());
let page_count = MetadataValue::Integer(42);
let relevance = MetadataValue::Float(0.95);
let is_verified = MetadataValue::Boolean(true);
let tags = MetadataValue::StringArray(vec!["rust".to_string(), "wasm".to_string()]);

// Type checking
assert!(title.is_string());
assert!(page_count.is_integer());
assert!(relevance.is_float());
assert!(is_verified.is_boolean());
assert!(tags.is_string_array());

// Value extraction
assert_eq!(title.as_string(), Some("Document Title"));
assert_eq!(page_count.as_integer(), Some(42));

Variants§

§

String(String)

UTF-8 string value (max 65,536 bytes).

Use for titles, descriptions, content, and any text data.

§

Integer(i64)

64-bit signed integer.

Use for counts, IDs, timestamps (Unix epoch), and numeric identifiers.

§

Float(f64)

64-bit IEEE 754 floating point.

Use for scores, weights, probabilities, and continuous values. Note: NaN and Infinity are rejected during validation.

§

Boolean(bool)

Boolean true/false.

Use for flags, binary filters, and on/off states.

§

StringArray(Vec<String>)

Array of UTF-8 strings (max 1,024 elements).

Use for tags, categories, labels, and multi-value fields.

Implementations§

Source§

impl MetadataValue

Source

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

Returns the type name as a static string.

This matches the JSON serialization type field.

§Example
use edgevec::metadata::MetadataValue;

assert_eq!(MetadataValue::String("hi".into()).type_name(), "string");
assert_eq!(MetadataValue::Integer(42).type_name(), "integer");
assert_eq!(MetadataValue::Float(2.5).type_name(), "float");
assert_eq!(MetadataValue::Boolean(true).type_name(), "boolean");
assert_eq!(MetadataValue::StringArray(vec![]).type_name(), "string_array");
Source

pub fn is_string(&self) -> bool

Returns true if this value is a String type.

Source

pub fn is_integer(&self) -> bool

Returns true if this value is an Integer type.

Source

pub fn is_float(&self) -> bool

Returns true if this value is a Float type.

Source

pub fn is_boolean(&self) -> bool

Returns true if this value is a Boolean type.

Source

pub fn is_string_array(&self) -> bool

Returns true if this value is a StringArray type.

Source

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

Attempts to extract the String value.

Returns None if this is not a String variant.

§Example
use edgevec::metadata::MetadataValue;

let value = MetadataValue::String("hello".to_string());
assert_eq!(value.as_string(), Some("hello"));

let value = MetadataValue::Integer(42);
assert_eq!(value.as_string(), None);
Source

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

Attempts to extract the Integer value.

Returns None if this is not an Integer variant.

§Example
use edgevec::metadata::MetadataValue;

let value = MetadataValue::Integer(42);
assert_eq!(value.as_integer(), Some(42));

let value = MetadataValue::Float(2.5);
assert_eq!(value.as_integer(), None);
Source

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

Attempts to extract the Float value.

Returns None if this is not a Float variant.

§Example
use edgevec::metadata::MetadataValue;

let value = MetadataValue::Float(2.5);
assert_eq!(value.as_float(), Some(2.5));

let value = MetadataValue::Integer(42);
assert_eq!(value.as_float(), None);
Source

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

Attempts to extract the Boolean value.

Returns None if this is not a Boolean variant.

§Example
use edgevec::metadata::MetadataValue;

let value = MetadataValue::Boolean(true);
assert_eq!(value.as_boolean(), Some(true));

let value = MetadataValue::Integer(1);
assert_eq!(value.as_boolean(), None);
Source

pub fn as_string_array(&self) -> Option<&[String]>

Attempts to extract the StringArray value.

Returns None if this is not a StringArray variant.

§Example
use edgevec::metadata::MetadataValue;

let value = MetadataValue::StringArray(vec!["a".into(), "b".into()]);
assert_eq!(value.as_string_array(), Some(&["a".to_string(), "b".to_string()][..]));

let value = MetadataValue::String("not an array".to_string());
assert_eq!(value.as_string_array(), None);

Trait Implementations§

Source§

impl Clone for MetadataValue

Source§

fn clone(&self) -> MetadataValue

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetadataValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for MetadataValue

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for MetadataValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for MetadataValue

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl<const N: usize> From<[&str; N]> for MetadataValue

Source§

fn from(arr: [&str; N]) -> Self

Converts to this type from the input type.
Source§

impl From<String> for MetadataValue

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<String>> for MetadataValue

Source§

fn from(arr: Vec<String>) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for MetadataValue

Source§

fn from(b: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f32> for MetadataValue

Source§

fn from(f: f32) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for MetadataValue

Source§

fn from(f: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for MetadataValue

Source§

fn from(i: i32) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for MetadataValue

Source§

fn from(i: i64) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for MetadataValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MetadataValue

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MetadataValue

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> ToString for T
where T: Display + ?Sized,

§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,