pub(crate) struct SchedulerState {
    inner: RwLock<InnerSchedulerState>,
}
Expand description

State of the IO scheduler, as stored on the Context.

The IO scheduler can be stopped or started, but core can also pause it. After pausing the IO scheduler will be restarted only if it was running before paused or Context::start_io was called in the meantime while it was paused.

Fields§

§inner: RwLock<InnerSchedulerState>

Implementations§

source§

impl SchedulerState

source

pub(crate) fn new() -> Self

source

pub(crate) async fn is_running(&self) -> bool

Whether the scheduler is currently running.

source

pub(crate) async fn start(&self, context: Context)

Starts the scheduler if it is not yet started.

source

async fn do_start( inner: RwLockWriteGuard<'_, InnerSchedulerState>, context: Context )

Starts the scheduler if it is not yet started.

source

pub(crate) async fn stop(&self, context: &Context)

Stops the scheduler if it is currently running.

source

async fn do_stop( inner: RwLockWriteGuard<'_, InnerSchedulerState>, context: &Context, new_state: InnerSchedulerState )

Stops the scheduler if it is currently running.

source

pub(crate) async fn pause<'a>(&self, context: Context) -> Result<IoPausedGuard>

Pauses the IO scheduler.

If it is currently running the scheduler will be stopped. When the IoPausedGuard is dropped the scheduler is started again.

If in the meantime SchedulerState::start or SchedulerState::stop is called resume will do the right thing and restore the scheduler to the state requested by the last call.

source

pub(crate) async fn restart(&self, context: &Context)

Restarts the scheduler, only if it is running.

source

pub(crate) async fn maybe_network(&self)

Indicate that the network likely has come back.

source

pub(crate) async fn maybe_network_lost(&self, context: &Context)

Indicate that the network likely is lost.

source

pub(crate) async fn interrupt_inbox(&self)

source

pub(crate) async fn interrupt_smtp(&self)

source

pub(crate) async fn interrupt_ephemeral_task(&self)

source

pub(crate) async fn interrupt_location(&self)

source

pub(crate) async fn interrupt_recently_seen( &self, contact_id: ContactId, timestamp: i64 )

Trait Implementations§

source§

impl Debug for SchedulerState

source§

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

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

impl Default for SchedulerState

source§

fn default() -> SchedulerState

Returns the “default value” for a type. 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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

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

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

source§

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

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

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

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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