Struct Control 

pub struct Control {
    stop: AtomicBool,
    nudge: AtomicBool,
    retry: AtomicBool,
    realtime: AtomicBool,
    pace: AtomicU64,
    quiet: AtomicBool,
    bell: Condvar,
    lock: Mutex<()>,
    wakers: Mutex<Vec<Waker>>,
}

How a watcher is told to stop, or to fetch now instead of waiting, and at what pace.

Fields

stop: AtomicBool

nudge: AtomicBool

retry: AtomicBool

“Sync now”: a refused password is tried again too.

realtime: AtomicBool

Every folder, every minute, until switched off.

pace: AtomicU64

Seconds between two fetches of the other folders; 0 for the default.

quiet: AtomicBool

The app in the background (a phone’s app put away): nothing starts on a timer but the inbox’s watch; a nudge still does, and leaving it is one.

bell: Condvar

Wakes the pauses at once (ring); lock keeps a ring from passing unheard between a look at the flags and the wait.

lock: Mutex<()>

wakers: Mutex<Vec<Waker>>

The async waits (the mail watcher’s), woken with the pauses.

Implementations

impl Control

pub fn set_realtime(&self, on: bool)

Real time on or off; on, it fetches now.

pub fn realtime(&self) -> bool

pub fn set_pace(&self, every: Duration)

The pace between two fetches; zero for the default.

fn round(&self) -> Duration

How long the inbox waits in IDLE, and the other folders between fetches.

fn slow(&self) -> bool

A pace slow enough to keep no connection open between fetches.

fn brings(&self, due: bool) -> (bool, bool)

What a round of the mail watcher brings besides the inbox’s new mail: the inbox’s changes and older mail, and the other folders when they are due. Quiet, neither: they wait for the first round after.

pub fn set_quiet(&self, quiet: bool)

Quiet or not: the app put away, or back. Quiet, a watcher starts nothing on its timer but the inbox’s IDLE (new mail is still noticed, the other folders wait); leaving it wakes the watcher, as a nudge.

pub fn quiet(&self) -> bool

pub fn stop(&self)

Ends the watch at the next occasion: at once when waiting.

pub fn nudge(&self)

Fetches now: ends the current wait, IDLE or pause.

pub fn retry(&self)

“Sync now”: a nudge, after which a watcher parked on a refused password tries it again, unchanged (see Parked).

pub(crate) fn retried(&self) -> bool

Whether “Sync now” was asked since last looked.

pub fn stopped(&self) -> bool

fn ring(&self)

Wakes every wait, to look at the flags again.

fn listen(&self, waker: &Waker)

An async wait, woken at the next ring.

pub fn pause(&self, length: Duration)

Waits length on this thread, or less when stopped or nudged. Counted on the wall clock too: a phone asleep for an hour ends a pause of 15 minutes as soon as it wakes. While quiet, only a nudge ends it.

fn pause_by( &self, length: Duration, wall: impl Fn() -> SystemTime, look: Duration, )

pause, the wall clock read with wall, at least every look.

pub fn park(&self) -> bool

Waits for a nudge, however long, quiet or not: a watcher parked after a lasting error, instead of ending. False when stopped.

fn wakes(&self) -> bool

Whether the wait should end; a nudge is used up by ending one.

Trait Implementations

impl Debug for Control

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

Formats the value using the given formatter.

impl Default for Control

fn default() -> Control

Returns the “default value” for a type.