Struct EmbeddingName 

pub struct EmbeddingName(/* private fields */);

A name for an embedding space.

Embedding names identify different embedding spaces associated with entities. For example, an entity might have text_embedding and image_embedding spaces.

Names must be non-empty and contain only alphanumeric characters, underscores, and hyphens.

Example

use manifoldb_vector::types::EmbeddingName;

let name = EmbeddingName::new("text_embedding").unwrap();
assert_eq!(name.as_str(), "text_embedding");

Implementations

impl EmbeddingName

pub fn new(name: impl Into<String>) -> Result<Self, VectorError>

Create a new embedding name.

Errors

Returns an error if the name is empty or contains invalid characters.

pub fn as_str(&self) -> &str

Get the name as a string slice.

pub fn into_string(self) -> String

Consume the name and return the underlying string.

Trait Implementations

impl AsRef<str> for EmbeddingName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for EmbeddingName

fn clone(&self) -> EmbeddingName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbeddingName

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

Formats the value using the given formatter.

impl Display for EmbeddingName

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

Formats the value using the given formatter.

impl Hash for EmbeddingName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EmbeddingName

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

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

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

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

impl Eq for EmbeddingName

impl StructuralPartialEq for EmbeddingName