Struct ObjectId 

pub struct ObjectId {
    pub context: ObjectContext,
    pub key: String,
}

The fully qualified identifier of an object.

This consists of a usecase and the scopes, which make up the object’s context and define where the object belongs within objectstore, as well as the unique key within the context.

Fields

context: ObjectContext

The usecase and scopes this object belongs to.

key: String

This key uniquely identifies the object within its usecase and scopes.

Note that keys can be reused across different contexts. Only in combination with the context a key makes a unique identifier.

Keys can be assigned by the service. For this, use ObjectId::random.

Implementations

impl ObjectId

pub fn new(context: ObjectContext, key: String) -> Self

Creates a new ObjectId with the given context and key.

pub fn from_parts(usecase: String, scopes: Scopes, key: String) -> Self

Creates a new ObjectId from all of its parts.

pub fn random(context: ObjectContext) -> Self

Creates a unique ObjectId with a random key.

This can be used when creating an object with a server-generated key.

pub fn optional(context: ObjectContext, key: Option<String>) -> Self

Creates a new ObjectId, generating a key if none is provided.

This creates a unique key like ObjectId::random if no key is provided, or otherwise uses the provided key.

pub fn key(&self) -> &str

Returns the key of the object.

See key for more information.

pub fn context(&self) -> &ObjectContext

Returns the context of the object.

See context for more information.

pub fn usecase(&self) -> &str

Returns the usecase of the object.

See ObjectContext::usecase for more information.

pub fn scopes(&self) -> &Scopes

Returns the scopes of the object.

See ObjectContext::scopes for more information.

pub fn iter_scopes(&self) -> impl Iterator<Item = &Scope>

Returns an iterator over all scopes of the object.

See ObjectContext::scopes for more information.

pub fn as_storage_path(&self) -> AsStoragePath<'_>

Returns a view that formats this ID as a storage path.

This will format a hierarchical path in the format {usecase}/{scope1.key}.{scope1.value}/.../{key} that is intended to be used by backends to reference the object in a storage system.

Trait Implementations

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl Hash for ObjectId

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 ObjectId

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

impl StructuralPartialEq for ObjectId