Struct Key

pub struct Key {
    pub namespace: String,
    pub set_name: String,
    pub user_key: Option<Value>,
    pub digest: [u8; 20],
}

Unique record identifier. Records can be identified using a specified namespace, an optional set name and a user defined key which must be uique within a set. Records can also be identified by namespace/digest, which is the combination used on the server.

Fields

namespace: String

Namespace.

set_name: String

Set name.

user_key: Option<Value>

Original user key.

digest: [u8; 20]

Unique server hash value generated from set name and user key.

Implementations

impl Key

pub fn new<S>(namespace: S, set_name: S, key: Value) -> Result<Self>

where S: Into<String>,

Construct a new key given a namespace, a set name and a user key value.

Panics

Only integers, strings and blobs (Vec<u8>) can be used as user keys. The constructor will panic if any other value type is passed.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl PartialEq for Key

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

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

const 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 StructuralPartialEq for Key