Struct CollectionKey 

pub struct CollectionKey<'a> { /* private fields */ }

The canonical (database_id, bare_name) identity of a collection.

Borrowed: it never allocates. Build it with Self::from_bare from a catalog name, or with Self::from_qualified / Self::from_qualified_str from a database-qualified name.

No From<&str> impl exists, so a raw string never converts implicitly:

use nodedb_types::CollectionKey;
let key: CollectionKey<'_> = "1024/users".into();

Implementations

impl<'a> CollectionKey<'a>

pub fn from_bare(database_id: DatabaseId, name: &'a str) -> Self

Build a key from the bare name the catalog keys the collection by.

name must be the catalog name, never a "{database_id}/{name}" string. A qualified name goes through Self::from_qualified.

pub fn from_qualified( database_id: DatabaseId, qualified: &'a QualifiedCollection, ) -> Result<Self, CollectionKeyError>

Build a key from a QualifiedCollection, stripping its qualifier.

pub fn from_qualified_str( database_id: DatabaseId, qualified: &'a str, ) -> Result<Self, CollectionKeyError>

Build a key from a database-qualified name carried as a string on a plan, a WAL record, or the wire.

The default database stores names unqualified, so the name is taken as-is. The empty name marks a plan with no routing collection and is the same in both forms, so it is also taken as-is. Any other name in any other database requires the exact "{database_id}/" prefix QualifiedCollection::new writes. Exactly one prefix is stripped, so a bare name that itself contains / survives intact.

pub fn database_id(&self) -> DatabaseId

The database the collection lives in.

pub fn name(&self) -> &'a str

The bare catalog name.

pub fn qualified(&self) -> QualifiedCollection

The database-qualified name storage engines key data by.

pub fn vshard(&self) -> VShardId

The vShard this collection homes to.

Trait Implementations

impl<'a> Clone for CollectionKey<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for CollectionKey<'a>

impl<'a> Debug for CollectionKey<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for CollectionKey<'a>

impl<'a> Hash for CollectionKey<'a>

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<'a> PartialEq for CollectionKey<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for CollectionKey<'a>