Skip to main content

WatchOptions

Struct WatchOptions 

Source
#[non_exhaustive]
pub struct WatchOptions { pub subtree: bool, pub retry: RetryMode, pub report_liveness: bool, pub on_volume_change: VolumeChangePolicy, }
Expand description

What a client states when it registers a subscription.

Non-exhaustive so that a future additive option is not a breaking change: build one with WatchOptions::new and the setters rather than a struct literal.

There is deliberately no change-type filter here, and none is planned. This crate’s contract is completeness: a change notification is positive evidence that a file was not finished, never evidence that it was, so a client can only decide “is it done yet?” by watching the change traffic go quiet. A filter would discard exactly that evidence, and under the crate’s per-directory coalescing it could not even be applied faithfully – the five content-ish change classes all arrive as one indistinguishable ChangeKind::Modified action. See D-77 in the crate’s design notes.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§subtree: bool

Whether changes below the target are reported as well.

§retry: RetryMode

How this subscription should be recovered from faults.

§report_liveness: bool

Whether Suspended/Resumed/Established are reported (D-13). Off by default: a subscription that only wants change data need not think about the fault machine’s liveness brackets at all.

§on_volume_change: VolumeChangePolicy

Whether to be asked before continuing when a reopen lands on a different volume than this subscription started on (D-78).

Implementations§

Source§

impl WatchOptions

Source

pub fn new() -> Self

A non-recursive watch that the monitor recovers autonomously.

Source

pub fn subtree(self, subtree: bool) -> Self

Report changes below the target as well.

Source

pub fn retry(self, retry: RetryMode) -> Self

Choose how faults are recovered from (D-27).

Source

pub fn report_liveness(self, report_liveness: bool) -> Self

Opt in to Suspended/Resumed/Established (D-13).

Source

pub fn on_volume_change(self, policy: VolumeChangePolicy) -> Self

Choose whether a volume change on reopen needs this subscription’s confirmation (D-78).

Trait Implementations§

Source§

impl Clone for WatchOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for WatchOptions

Source§

impl Debug for WatchOptions

Source§

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

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

impl Default for WatchOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for WatchOptions

Source§

impl Hash for WatchOptions

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for WatchOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WatchOptions

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, dest: *mut u8)

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.