Struct CollectionName 

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

A validated collection name.

Collection names identify different vector collections. Names must be non-empty and contain only alphanumeric characters, underscores, and hyphens.

Example

use manifoldb_vector::types::CollectionName;

let name = CollectionName::new("documents").unwrap();
assert_eq!(name.as_str(), "documents");

Implementations

impl CollectionName

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

Create a new collection 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 CollectionName

fn as_ref(&self) -> &str

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

impl Clone for CollectionName

fn clone(&self) -> CollectionName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CollectionName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CollectionName

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

Formats the value using the given formatter.

impl Hash for CollectionName

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 CollectionName

fn eq(&self, other: &CollectionName) -> 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 Serialize for CollectionName

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CollectionName

impl StructuralPartialEq for CollectionName