Struct WatchOptions 

pub struct WatchOptions {
    pub lifetime: Lifetime,
    pub renewal_margin: Duration,
    pub poll_every: Duration,
    pub poll_floor: Duration,
    pub poll_backoff: Backoff,
    pub retry_cov: Backoff,
    pub missing: MissingDevice,
    pub reads: Reads,
    pub coalesce: Duration,
    pub samples: usize,
    pub max_points: usize,
    pub bucket: Option<Arc<TokenBucket>>,
}

The hub’s settings.

Fields

lifetime: Lifetime

Each subscription’s lifetime.

renewal_margin: Duration

How long before a lifetime ends the renewal goes. It covers a wait for the device’s gate and the renewal’s own request with retries (see renewal_margin).

poll_every: Duration

Least time between two polls of a device, all its polled points read together; at least poll_floor.

poll_floor: Duration

The shortest poll_every taken; at least POLL_FLOOR.

poll_backoff: Backoff

How long a device that stopped answering polls waits for the next.

retry_cov: Backoff

After a subscription failed for want of an answer (rather than a refusal), or a renewal failed, how long the point is polled before it is read and subscribed again; never sooner than poll_floor.

missing: MissingDevice

What a point does whose device isn’t in the discovery table.

reads: Reads

What a point reads.

coalesce: Duration

Changes to one point within this window make one signal; zero for a signal per change.

samples: usize

Samples a lease’s stream (Lease::samples) holds at least before the oldest go (the channel rounds it up to a power of two).

max_points: usize

Points watched at once, those still cancelling included.

bucket: Option<Arc<TokenBucket>>

The hub’s own rate, taken by each request it sends but cancels; None for none beyond the engine’s limits.

Implementations

impl WatchOptions

pub fn validate(&self) -> Result<(), String>

Check the settings: polls no faster than the floor, a renewal margin inside the lifetime, backoffs that start above zero, room for one point and its rows.

Trait Implementations

impl Clone for WatchOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchOptions

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

Formats the value using the given formatter.

impl Default for WatchOptions

fn default() -> Self

Returns the “default value” for a type.