Struct ProviderConnector 

pub struct ProviderConnector { /* private fields */ }

The provider composition root retains the supplied clock and id source, and the one HTTP client every connection it makes sends through.

Implementations

impl ProviderConnector

pub fn new(clock: ClockRef, ids: IdSourceRef) -> Self

Retain the capabilities used to construct subsequent connections.

pub fn with_folder_api(self, api: String) -> Self

Send account and folder calls to an in-process provider API in application tests.

pub async fn empty_s3_bucket( &self, config: StorageConfig, credentials: S3Credentials, ) -> Result<EmptiedS3Bucket, EmptyS3BucketError>

Delete every object and abort every unfinished upload in an S3 location’s bucket, once its root shows it holds only stores, with this connector’s clock, ids and HTTP client (api.md E14). A development tool outside the sync protocol.

Trait Implementations

impl StorageConnector for ProviderConnector

fn onedrive_root<'life0, 'async_trait>( &'life0 self, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<StorageFolder, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read the signed-in OneDrive root.

fn onedrive_folders<'life0, 'life1, 'async_trait>( &'life0 self, parent: &'life1 StorageConfig, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<Vec<StorageFolder>, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read all immediate OneDrive child folders.

fn create_onedrive_folder<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, parent: &'life1 StorageConfig, name: &'life2 str, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<StorageFolder, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create a OneDrive folder without renaming or replacing an occupied name.

fn dropbox_shared_folders<'life0, 'async_trait>( &'life0 self, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<Vec<StorageFolder>, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read all shared Dropbox namespaces.

fn create_dropbox_shared_folder<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<StorageFolder, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Make a folder named name at the top of the signed-in Dropbox and share it, refusing a name already taken.

fn account_label<'life0, 'async_trait>( &'life0 self, auth: ProviderAuth, cooldown: Arc<dyn Cooldown>, ) -> Pin<Box<dyn Future<Output = Result<String, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read the signed-in account’s display label before recording a member’s location.

fn prepare_cloudkit<'life0, 'life1, 'async_trait>( &'life0 self, container: &'life1 str, store: StoreId, ) -> Pin<Box<dyn Future<Output = Result<StorageConfig, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create the owner’s CloudKit location from the entitled container. A connector without native CloudKit support refuses this capability.

fn connect<'life0, 'async_trait>( &'life0 self, config: StorageConfig, auth: ProviderAuth, device: DeviceId, publications: Arc<dyn PublicationGate>, cooldown: Arc<dyn Cooldown>, transfers: Arc<TransferBudget>, ) -> Pin<Box<dyn Future<Output = Result<Arc<StorageConnection>, StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Validate settings and wrap the selected native provider once. The caller verifies the connection before publication. Every request waits for the store’s shared cooldown; a rejected OAuth token is refreshed in the sign-in’s custody (§20.2). A setup call makes its own connection beside it (StorageConnection::during_setup) for its requests to draw on its waits (§20.8). The connection writes for device: what it stages sits in that device’s reserved folder (D10).

fn detect_s3<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, config: StorageConfig, credentials: S3Credentials, store: StoreId, runs: &'life1 S3DetectionRuns, waits: &'life2 SetupWaits, ) -> Pin<Box<dyn Future<Output = S3DetectionRun> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Probe an S3 location’s service (§20.7), writing only fresh objects under the store’s .coven-check/<run>/ prefix for runs.run and deleting them, also on failure, then removing what each of runs.earlier left there. The caller recorded runs.run before calling; the answer names the runs whose probes and uploads are confirmed gone. A connector without native S3 refuses this capability. A rate-limited probe is sent again while setup’s waits allow (§20.8).

fn check_new_store<'life0, 'life1, 'async_trait>( &'life0 self, config: StorageConfig, auth: ProviderAuth, store: StoreId, waits: &'life1 SetupWaits, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Before a store’s first setup at a location it needs to itself (a Dropbox shared folder, a OneDrive folder, or an S3 bucket), refuse a location whose root holds anything outside the store’s folder or the coven-location marker (§20.3). Reads only. A connector without that provider refuses this capability. A rate-limited listing is sent again while setup’s waits allow.