Skip to main content

StopRecord

Struct StopRecord 

Source
pub struct StopRecord { /* private fields */ }
Expand description

Immutable provenance for the first accepted STOP request.

Implementations§

Source§

impl StopRecord

Source

pub fn actor(&self) -> &str

The party or subsystem that requested STOP.

Examples found in repository?
examples/worker.rs (line 13)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let signal = CocoshigaStop::new();
5    let worker = signal.clone();
6
7    signal.request_stop("operator", "maintenance window")?;
8
9    match worker.checkpoint() {
10        Ok(()) => println!("worker continues"),
11        Err(stopped) => println!(
12            "worker stopped by {}: {}",
13            stopped.record().actor(),
14            stopped.record().reason()
15        ),
16    }
17
18    Ok(())
19}
Source

pub fn reason(&self) -> &str

The reason supplied with the STOP request.

Examples found in repository?
examples/worker.rs (line 14)
3fn main() -> Result<(), Box<dyn std::error::Error>> {
4    let signal = CocoshigaStop::new();
5    let worker = signal.clone();
6
7    signal.request_stop("operator", "maintenance window")?;
8
9    match worker.checkpoint() {
10        Ok(()) => println!("worker continues"),
11        Err(stopped) => println!(
12            "worker stopped by {}: {}",
13            stopped.record().actor(),
14            stopped.record().reason()
15        ),
16    }
17
18    Ok(())
19}

Trait Implementations§

Source§

impl Clone for StopRecord

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 Debug for StopRecord

Source§

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

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

impl Eq for StopRecord

Source§

impl Hash for StopRecord

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 StopRecord

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 StopRecord

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.