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 unique 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<Key, Error>

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.

pub fn key_with_digest<S>( namespace: String, set_name: Option<String>, key: Option<Value>, digest: [u8; 20], ) -> Result<Key, Error>

where S: Into<String>,

Construct a new key from namespace, optional set name, user key and digest. The server handles record identifiers by digest only. The digest will be set to the provided value and not validated.

pub fn partition_id(&self) -> usize

Returns the partitionId of the key.

Panics

Panics if the digest slice cannot be read as a u32 in little-endian byte order.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), 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 ==.

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 Key

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Key

impl StructuralPartialEq for Key