Struct mugle_util::StopState

source · [−]

pub struct StopState { /* private fields */ }

Expand description

Global stopped/paused state shared across various subcomponents of Mugle.

“Stopped” allows a clean shutdown of the Mugle server. “Paused” is used in some tests to allow nodes to reach steady state etc.

Implementations

source

impl StopState

source

pub fn new() -> StopState

Create a new stop_state in default “running” state.

source

pub fn is_stopped(&self) -> bool

Check if we are stopped.

source

pub fn is_paused(&self) -> bool

Check if we are paused.

source

pub fn stop(&self)

Stop the server.

source

pub fn pause(&self)

Pause the server (only used in tests).

source

pub fn resume(&self)

Resume a paused server (only used in tests).

Auto Trait Implementations

impl RefUnwindSafe for StopState

impl Send for StopState

impl Sync for StopState

impl Unpin for StopState

impl UnwindSafe for StopState

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct mugle_util::StopState

Implementations

impl StopState

pub fn new() -> StopState

pub fn is_stopped(&self) -> bool

pub fn is_paused(&self) -> bool

pub fn stop(&self)

pub fn pause(&self)

pub fn resume(&self)

Auto Trait Implementations

impl RefUnwindSafe for StopState

impl Send for StopState

impl Sync for StopState

impl Unpin for StopState

impl UnwindSafe for StopState

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> UnsafeAny for T where
T: Any,

Struct mugle_util::StopState

Implementations

impl StopState

pub fn new() -> StopState

pub fn is_stopped(&self) -> bool

pub fn is_paused(&self) -> bool

pub fn stop(&self)

pub fn pause(&self)

pub fn resume(&self)

Auto Trait Implementations

impl RefUnwindSafe for StopState

impl Send for StopState

impl Sync for StopState

impl Unpin for StopState

impl UnwindSafe for StopState

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> UnsafeAny for T where T: Any,

impl<T> Any for T where
T: 'static + ?Sized,

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

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

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

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

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

impl<T> UnsafeAny for T where
T: Any,