Struct garage_model::key_table::Key

pub struct Key {
    pub key_id: String,
    pub state: Deletable<KeyParams>,
}

An api key

Fields

key_id: String

The id of the key (immutable), used as partition key

state: Deletable<KeyParams>

Internal state of the key

Implementations

impl Key

pub fn new(name: &str) -> Self

Initialize a new Key, generating a random identifier and associated secret key

pub fn import(key_id: &str, secret_key: &str, name: &str) -> Self

Import a key from it’s parts

pub fn delete(key_id: String) -> Self

Create a new Key which can me merged to mark an existing key deleted

pub fn is_deleted(&self) -> bool

Returns true if this represents a deleted bucket

pub fn params(&self) -> Option<&KeyParams>

Returns an option representing the params (None if in deleted state)

pub fn params_mut(&mut self) -> Option<&mut KeyParams>

Mutable version of .state()

pub fn bucket_permissions(&self, bucket: &Uuid) -> BucketKeyPerm

Get permissions for a bucket

pub fn allow_read(&self, bucket: &Uuid) -> bool

Check if Key is allowed to read in bucket

pub fn allow_write(&self, bucket: &Uuid) -> bool

Check if Key is allowed to write in bucket

pub fn allow_owner(&self, bucket: &Uuid) -> bool

Check if Key is owner of bucket

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Crdt for Key

fn merge(&mut self, other: &Self)

Merge the two datastructures according to the CRDT rules. self is modified to contain the merged CRDT value. other is not modified.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Entry<EmptyKey, String> for Key

fn partition_key(&self) -> &EmptyKey

Get the key used to partition

fn sort_key(&self) -> &String

Get the key used to sort

fn is_tombstone(&self) -> bool

Is the entry a tombstone? Default implementation always return false

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Key

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Key