Enum StorageConfig 

pub enum StorageConfig {
    S3 {
        bucket: String,
        region: String,
        endpoint: Option<Url>,
        profile: Option<S3Profile>,
    },
    Dropbox {
        location: DropboxLocation,
        account_label: Option<String>,
        folder_label: Option<FolderLabel>,
    },
    OneDrive {
        drive_id: String,
        folder_id: String,
        account_label: Option<String>,
        folder_label: Option<FolderLabel>,
    },
    CloudKit {
        container: String,
        owner: String,
        zone: String,
    },
}

The store’s location; credentials are kept separately in key custody.

Variants

S3

An existing S3 bucket, which the store has to itself: coven can’t tell how far a member’s key reaches, so it takes every key to reach the whole bucket (§20.7). Paths start at the bucket’s root.

Fields

bucket: String

Bucket name.

region: String

Signing region.

endpoint: Option<Url>

None is AWS’s own endpoint. Catalogued hosts (Appendix E.3) require https.

profile: Option<S3Profile>

A catalogued service’s name or custom settings; either must agree with a catalogued endpoint host. None selects by host: storage.googleapis.com is GCS XML, hosts ending in .r2.cloudflarestorage.com are R2, no endpoint or .amazonaws.com is AWS, and setup detects any other endpoint’s settings, recording them as Custom. All run the setup checks.

Dropbox

Dropbox’s access and location, fixed when cloud storage is created.

Fields

location: DropboxLocation

Required choice: not-shared App folder or a shared-capable namespace.

account_label: Option<String>

Signed-in member’s display label; absent before setup. Never routes or authorizes.

folder_label: Option<FolderLabel>

The shared folder’s name and web address as the latest connection read them; absent before setup and in the App folder (§20.2).

OneDrive

A OneDrive folder; paths within it start with the store id.

Fields

drive_id: String

Drive containing the folder.

folder_id: String

Folder shared with members’ Microsoft accounts.

account_label: Option<String>

Signed-in member’s display label; absent before setup. Never routes or authorizes.

folder_label: Option<FolderLabel>

The folder’s name and web address as the latest connection read them; absent before setup (§20.2).

CloudKit

The custom zone reached by the built-in CloudKit adapter.

Fields

container: String

App’s CloudKit container.

owner: String

Owner’s CloudKit record name.

zone: String

Custom zone containing the store.

Implementations

impl StorageConfig

pub fn same_location(&self, other: &StorageConfig) -> bool

Whether these settings reach the same location, ignoring display labels.

pub fn same_s3_bucket(&self, other: &StorageConfig) -> bool

Whether both are S3 locations naming the same bucket, at one endpoint and region, whatever profile reaches it.

pub fn holds_one_store(&self) -> bool

Whether every member reaches the whole location, so it holds one store, which the location marker at its root names (§20.3): a Dropbox shared folder, a OneDrive folder, or an S3 bucket. Nobody else reaches the Dropbox App folder, and a CloudKit store’s zone is its own.

pub fn oauth_access(&self) -> Option<OAuthAccess>

Access required to open this location.

pub fn provider(&self) -> CloudProvider

The provider of this location.

pub fn validate(&self) -> Result<(), StorageError>

Reject missing location information before making a request.

Trait Implementations

impl Clone for StorageConfig

fn clone(&self) -> StorageConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StorageConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StorageConfig

fn eq(&self, other: &StorageConfig) -> 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 StorageConfig

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 StorageConfig

impl StructuralPartialEq for StorageConfig