Struct DocumentKey 

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

A validated object key such as tenant/project/Binary/123.

Keys are non-empty UTF-8 of at most 1024 bytes with no control characters, no leading slash and no empty, . or .. segments. Slashes mean nothing to an object store, but they keep related documents listable by prefix and keep keys safe for a filesystem-backed implementation.

Implementations

impl DocumentKey

pub fn new(key: impl Into<String>) -> Result<Self, StorageError>

Validates key against the rules above.

Errors

Returns StorageError::InvalidKey naming the broken rule.

pub fn from_backend(name: String) -> Self

Wraps a name read back from a backend without validating it. Only backends should call this; whatever is in the store is reported as is.

pub fn as_str(&self) -> &str

Trait Implementations

impl AsRef<str> for DocumentKey

fn as_ref(&self) -> &str

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

impl Clone for DocumentKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentKey

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

Formats the value using the given formatter.

impl Display for DocumentKey

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

Formats the value using the given formatter.

impl Eq for DocumentKey

impl From<DocumentKey> for String

fn from(key: DocumentKey) -> Self

Converts to this type from the input type.

impl FromStr for DocumentKey

type Err = StorageError

The associated error which can be returned from parsing.

fn from_str(key: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DocumentKey

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 Ord for DocumentKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for DocumentKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DocumentKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DocumentKey