Struct Session

pub struct Session(/* private fields */);

A builder to create a new connection for the sync root at the specified path.

Implementations

impl Session

pub fn new() -> Self

Create a new Session.

pub fn block_implicit_hydration(self) -> Self

The Session::block_implicit_hydration flag will prevent implicit placeholder hydrations from invoking SyncFilter::fetch_data. This could occur when an anti-virus is scanning file system activity on files within the sync root.

A call to the Placeholder::hydrate trait will not be blocked by this flag.

pub fn connect<P, F>(self, path: P, filter: F) -> Result<Connection<F>>

where P: AsRef<Path>, F: SyncFilter + 'static,

Initiates a connection to the sync root with the given SyncFilter.

pub fn connect_async<P, F, B>( self, path: P, filter: F, block_on: B, ) -> Result<Connection<AsyncBridge<F, B>>>

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

Initiates a connection to the sync root with the given Filter.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Session

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Session