Struct garage_model::helper::bucket::BucketHelper

pub struct BucketHelper<'a>(_);

Implementations

impl<'a> BucketHelper<'a>

pub async fn resolve_global_bucket_name(
    &self,
    bucket_name: &String
) -> Result<Option<Uuid>, Error>

pub async fn get_internal_bucket(
    &self,
    bucket_id: Uuid
) -> Result<Bucket, Error>

Returns a Bucket if it is present in bucket table, even if it is in deleted state. Querying a non-existing bucket ID returns an internal error.

pub async fn get_existing_bucket(
    &self,
    bucket_id: Uuid
) -> Result<Bucket, Error>

Returns a Bucket if it is present in bucket table, only if it is in non-deleted state. Querying a non-existing bucket ID or a deleted bucket returns a bad request error.

pub async fn get_internal_key(&self, key_id: &String) -> Result<Key, Error>

Returns a Key if it is present in key table, even if it is in deleted state. Querying a non-existing key ID returns an internal error.

pub async fn get_existing_key(&self, key_id: &String) -> Result<Key, Error>

Returns a Key if it is present in key table, only if it is in non-deleted state. Querying a non-existing key ID or a deleted key returns a bad request error.

pub async fn get_existing_matching_key(
    &self,
    pattern: &str
) -> Result<Key, Error>

Returns a Key if it is present in key table, looking it up by key ID or by a match on its name, only if it is in non-deleted state. Querying a non-existing key ID or a deleted key returns a bad request error.

pub async fn set_global_bucket_alias(
    &self,
    bucket_id: Uuid,
    alias_name: &String
) -> Result<(), Error>

Sets a new alias for a bucket in global namespace. This function fails if:

• alias name is not valid according to S3 spec
• bucket does not exist or is deleted
• alias already exists and points to another bucket

pub async fn unset_global_bucket_alias(
    &self,
    bucket_id: Uuid,
    alias_name: &String
) -> Result<(), Error>

Unsets an alias for a bucket in global namespace. This function fails if:

• bucket does not exist or is deleted
• alias does not exist or maps to another bucket (-> internal error)
• bucket has no other aliases (global or local)

pub async fn purge_global_bucket_alias(
    &self,
    bucket_id: Uuid,
    alias_name: &String
) -> Result<(), Error>

Ensures a bucket does not have a certain global alias. Contrarily to unset_global_bucket_alias, this does not fail on any condition other than:

• bucket cannot be found (its fine if it is in deleted state)
• alias cannot be found (its fine if it points to nothing or to another bucket)

pub async fn set_local_bucket_alias(
    &self,
    bucket_id: Uuid,
    key_id: &String,
    alias_name: &String
) -> Result<(), Error>

Sets a new alias for a bucket in the local namespace of a key. This function fails if:

• alias name is not valid according to S3 spec
• bucket does not exist or is deleted
• key does not exist or is deleted
• alias already exists and points to another bucket

pub async fn unset_local_bucket_alias(
    &self,
    bucket_id: Uuid,
    key_id: &String,
    alias_name: &String
) -> Result<(), Error>

Unsets an alias for a bucket in the local namespace of a key. This function fails if:

• bucket does not exist or is deleted
• key does not exist or is deleted
• alias does not exist or maps to another bucket (-> internal error)
• bucket has no other aliases (global or local)

pub async fn set_bucket_key_permissions(
    &self,
    bucket_id: Uuid,
    key_id: &String,
    perm: BucketKeyPerm
) -> Result<(), Error>

Sets permissions for a key on a bucket. This function fails if:

• bucket or key cannot be found at all (its ok if they are in deleted state)
• bucket or key is in deleted state and we are trying to set permissions other than “deny all”