Struct distant_core::Watcher

source · [−]

pub struct Watcher { /* private fields */ }

Expand description

Represents a watcher of some path on a remote machine

Implementations

source

impl Watcher

source

pub async fn watch(
 tenant: impl Into<String>,
 channel: SessionChannel,
 path: impl Into<PathBuf>,
 recursive: bool,
 only: impl Into<ChangeKindSet>,
 except: impl Into<ChangeKindSet>
) -> Result<Self, WatchError>

Creates a watcher for some remote path

source

pub fn path(&self) -> &Path

Returns a reference to the path this watcher is monitoring

source

pub fn is_active(&self) -> bool

Returns true if the watcher is still actively watching for changes

source

pub async fn next(&mut self) -> Option<Change>

Returns the next change detected by the watcher, or none if the watcher has concluded

source

pub async fn unwatch(&mut self) -> Result<(), UnwatchError>

Unwatches the path being watched, closing out the watcher

Trait Implementations

source

impl Debug for Watcher

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Watcher

impl Send for Watcher

impl Sync for Watcher

impl Unpin for Watcher

impl !UnwindSafe for Watcher

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct distant_core::Watcher

Implementations

impl Watcher

pub async fn watch(
    tenant: impl Into<String>,
    channel: SessionChannel,
    path: impl Into<PathBuf>,
    recursive: bool,
    only: impl Into<ChangeKindSet>,
    except: impl Into<ChangeKindSet>
) -> Result<Self, WatchError>

pub fn path(&self) -> &Path

pub fn is_active(&self) -> bool

pub async fn next(&mut self) -> Option<Change>

pub async fn unwatch(&mut self) -> Result<(), UnwatchError>

Trait Implementations

impl Debug for Watcher

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

Auto Trait Implementations

impl !RefUnwindSafe for Watcher

impl Send for Watcher

impl Sync for Watcher

impl Unpin for Watcher

impl !UnwindSafe for Watcher

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

Struct distant_core::Watcher

Implementations

impl Watcher

pub async fn watch( tenant: impl Into<String>, channel: SessionChannel, path: impl Into<PathBuf>, recursive: bool, only: impl Into<ChangeKindSet>, except: impl Into<ChangeKindSet>) -> Result<Self, WatchError>

pub fn path(&self) -> &Path

pub fn is_active(&self) -> bool

pub async fn next(&mut self) -> Option<Change>

pub async fn unwatch(&mut self) -> Result<(), UnwatchError>

Trait Implementations

impl Debug for Watcher

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

Auto Trait Implementations

impl !RefUnwindSafe for Watcher

impl Send for Watcher

impl Sync for Watcher

impl Unpin for Watcher

impl !UnwindSafe for Watcher

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub async fn watch(
tenant: impl Into<String>,
channel: SessionChannel,
path: impl Into<PathBuf>,
recursive: bool,
only: impl Into<ChangeKindSet>,
except: impl Into<ChangeKindSet>
) -> Result<Self, WatchError>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,