Trait SyncFilter

pub trait SyncFilter: Send + Sync {
    // Required method
    fn fetch_data(
        &self,
        _request: Request,
        _ticket: FetchData,
        _info: FetchData,
    ) -> CResult<()>;

    // Provided methods
    fn cancel_fetch_data(&self, _request: Request, _info: CancelFetchData) { ... }
    fn validate_data(
        &self,
        _request: Request,
        _ticket: ValidateData,
        _info: ValidateData,
    ) -> CResult<()> { ... }
    fn fetch_placeholders(
        &self,
        _request: Request,
        _ticket: FetchPlaceholders,
        _info: FetchPlaceholders,
    ) -> CResult<()> { ... }
    fn cancel_fetch_placeholders(
        &self,
        _request: Request,
        _info: CancelFetchPlaceholders,
    ) { ... }
    fn opened(&self, _request: Request, _info: Opened) { ... }
    fn closed(&self, _request: Request, _info: Closed) { ... }
    fn dehydrate(
        &self,
        _request: Request,
        _ticket: Dehydrate,
        _info: Dehydrate,
    ) -> CResult<()> { ... }
    fn dehydrated(&self, _request: Request, _info: Dehydrated) { ... }
    fn delete(
        &self,
        _request: Request,
        _ticket: Delete,
        _info: Delete,
    ) -> CResult<()> { ... }
    fn deleted(&self, _request: Request, _info: Deleted) { ... }
    fn rename(
        &self,
        _request: Request,
        _ticket: Rename,
        _info: Rename,
    ) -> CResult<()> { ... }
    fn renamed(&self, _request: Request, _info: Renamed) { ... }
    fn state_changed(&self, _changes: Vec<PathBuf>) { ... }
}

Core functions for implementing a Sync Engine.

Send and Sync are required as the callback could be invoked from an arbitrary thread, read here.

Required Methods

fn fetch_data( &self, _request: Request, _ticket: FetchData, _info: FetchData, ) -> CResult<()>

A placeholder hydration has been requested. This means that the placeholder should be populated with its corresponding data on the remote.

Provided Methods

fn cancel_fetch_data(&self, _request: Request, _info: CancelFetchData)

A placeholder hydration request has been cancelled.

fn validate_data( &self, _request: Request, _ticket: ValidateData, _info: ValidateData, ) -> CResult<()>

Followed by a successful call to SyncFilter::fetch_data, this callback should verify the integrity of the data persisted in the placeholder.

You are responsible for validating the data in the placeholder. To approve the request, use the ticket provided.

Note that this callback is only called if HydrationPolicy::ValidationRequired is specified.

fn fetch_placeholders( &self, _request: Request, _ticket: FetchPlaceholders, _info: FetchPlaceholders, ) -> CResult<()>

A directory population has been requested. The behavior of this callback is dependent on the PopulationType variant specified during registration.

fn cancel_fetch_placeholders( &self, _request: Request, _info: CancelFetchPlaceholders, )

A directory population request has been cancelled.

fn opened(&self, _request: Request, _info: Opened)

A placeholder file handle has been opened for read, write, and/or delete access.

fn closed(&self, _request: Request, _info: Closed)

A placeholder file handle that has been previously opened with read, write, and/or delete access has been closed.

fn dehydrate( &self, _request: Request, _ticket: Dehydrate, _info: Dehydrate, ) -> CResult<()>

A placeholder dehydration has been requested. This means that all of the data persisted in the file will be completely discarded.

The operating system will handle dehydrating placeholder files automatically. However, it is up to you to approve this. Use the ticket to approve the request.

fn dehydrated(&self, _request: Request, _info: Dehydrated)

A placeholder dehydration request has been cancelled.

fn delete( &self, _request: Request, _ticket: Delete, _info: Delete, ) -> CResult<()>

A placeholder file is about to be deleted.

The operating system will handle deleting placeholder files automatically. However, it is up to you to approve this. Use the ticket to approve the request.

fn deleted(&self, _request: Request, _info: Deleted)

A placeholder file has been deleted.

fn rename( &self, _request: Request, _ticket: Rename, _info: Rename, ) -> CResult<()>

A placeholder file is about to be renamed or moved.

The operating system will handle moving and renaming placeholder files automatically. However, it is up to you to approve this. Use the ticket to approve the request.

When the operation is completed, the SyncFilter::renamed callback will be called.

fn renamed(&self, _request: Request, _info: Renamed)

A placeholder file has been renamed or moved.

fn state_changed(&self, _changes: Vec<PathBuf>)

Placeholder for changed attributes under the sync root.

This callback is implemented using ReadDirectoryChangesW so it is not provided by the Cloud Filter APIs.

This callback is used to detect when a user pins or unpins a placeholder file, etc.

See also Cloud Files API Frequently Asked Questions.

Implementors

impl<F, B> SyncFilter for AsyncBridge<F, B>

where F: Filter, B: Fn(Pin<Box<dyn Future<Output = ()> + '_>>) + Send + Sync,