Struct garage_model::bucket_table::Bucket

pub struct Bucket {
    pub id: Uuid,
    pub state: Deletable<BucketParams>,
}

A bucket is a collection of objects

Its parameters are not directly accessible as:

• It must be possible to merge paramaters, hence the use of a LWW CRDT.
• A bucket has 2 states, Present or Deleted and parameters make sense only if present.

Fields

id: Uuid

ID of the bucket

state: Deletable<BucketParams>

State, and configuration if not deleted, of the bucket

Implementations

impl Bucket

pub fn new() -> Self

Initializes a new instance of the Bucket struct

pub fn present(id: Uuid, params: BucketParams) -> Self

pub fn is_deleted(&self) -> bool

Returns true if this represents a deleted bucket

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

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

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

Mutable version of .params()

pub fn authorized_keys(&self) -> &[(String, BucketKeyPerm)]

Return the list of authorized keys, when each was updated, and the permission associated to the key

pub fn aliases(&self) -> &[(String, u64, bool)]

pub fn local_aliases(&self) -> &[((String, String), u64, bool)]

Trait Implementations

impl Clone for Bucket

fn clone(&self) -> Bucket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Crdt for Bucket

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 Bucket

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

Formats the value using the given formatter.

impl Default for Bucket

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bucket

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Entry<EmptyKey, FixedBytes32> for Bucket

fn partition_key(&self) -> &EmptyKey

Get the key used to partition

fn sort_key(&self) -> &Uuid

Get the key used to sort

fn is_tombstone(&self) -> bool

Is the entry a tombstone? Default implementation always return false

impl InitialFormat for Bucket

const VERSION_MARKER: &'static [u8] = b""

A sequence of bytes to add at the beginning of the serialized string, to identify that the data is of this version.

impl PartialEq for Bucket

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Bucket

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Bucket

impl StructuralPartialEq for Bucket