zng_ext_fs_watcher

Struct FsChangesArgs

source
pub struct FsChangesArgs {
    pub timestamp: DInstant,
    pub changes: Arc<Vec<FsChange>>,
    /* private fields */
}
Expand description

FS_CHANGES_EVENT arguments.

Fields§

§timestamp: DInstant

Instant the event happened.

§changes: Arc<Vec<FsChange>>

All notify changes since the last event.

Implementations§

source§

impl FsChangesArgs

source

pub fn new( timestamp: impl Into<DInstant>, propagation_handle: EventPropagationHandle, changes: impl Into<Arc<Vec<FsChange>>>, ) -> Self

New args from values that convert into the argument types.

source

pub fn now(changes: impl Into<Arc<Vec<FsChange>>>) -> Self

Arguments for event that happened now (INSTANT.now).

source§

impl FsChangesArgs

source

pub fn events(&self) -> impl Iterator<Item = &Event> + '_

Iterate over all change events.

source

pub fn errors(&self) -> impl Iterator<Item = &Error> + '_

Iterate over all file watcher errors.

source

pub fn rescan(&self) -> bool

Returns true is some events where lost.

This indicates either a lapse in the events or a change in the filesystem such that events received so far can no longer be relied on to represent the state of the filesystem now.

An application that simply reacts to file changes may not care about this. An application that keeps an in-memory representation of the filesystem will need to care, and will need to refresh that representation directly from the filesystem.

source

pub fn changes_for( &self, glob: &str, ) -> Result<impl Iterator<Item = &FsChange> + '_, PatternError>

Iterate over all changes that affects paths selected by the glob pattern.

source

pub fn changes_for_path<'a>( &'a self, path: &'a Path, ) -> impl Iterator<Item = &'a FsChange> + 'a

Iterate over all changes that affects paths that are equal to path or inside it.

source

pub fn events_for( &self, glob: &str, ) -> Result<impl Iterator<Item = &Event> + '_, PatternError>

Iterate over all change events that affects that are equal to path or inside it.

source

pub fn events_for_path<'a>( &'a self, path: &'a Path, ) -> impl Iterator<Item = &'a Event> + 'a

Iterate over all change events that affects paths that are equal to path or inside it.

Trait Implementations§

source§

impl AnyEventArgs for FsChangesArgs

source§

fn delivery_list(&self, list: &mut UpdateDeliveryList)

None, only app level handlers receive this event.

source§

fn clone_any(&self) -> Box<dyn AnyEventArgs>

Clone the event into a type erased box.
source§

fn as_any(&self) -> &dyn Any

Access to dyn Any methods.
source§

fn timestamp(&self) -> DInstant

Gets the instant this event happened.
source§

fn propagation(&self) -> &EventPropagationHandle

Propagation handle associated with this event instance. Read more
source§

impl Clone for FsChangesArgs

source§

fn clone(&self) -> FsChangesArgs

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FsChangesArgs

source§

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

Formats the value using the given formatter. Read more
source§

impl EventArgs for FsChangesArgs

source§

fn handle<F, R>(&self, handler: F) -> Option<R>
where F: FnOnce(&Self) -> R,

Calls handler and stops propagation if propagation is still allowed. Read more

Auto Trait Implementations§

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,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FsChangeNote for T
where T: Debug + Any + Send + Sync,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Access any.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> StateValue for T
where T: Any + Send + Sync,