Skip to main content

ProgramStatusState

Struct ProgramStatusState 

Source
pub struct ProgramStatusState<'a>(/* private fields */);
Expand description

State of a program or one of its tasks.

Standard names are associated constants. Use Self::new for a name advertised by a protocol extension. The writer validates names before output; construction does not establish terminal support.

State and kind names are distinct types:

ⓘ
use uncurses::ansi::program_status::{ProgramStatus, ProgramStatusKind};

let report = ProgramStatus::new(ProgramStatusKind::AUTH);

Implementations§

Source§

impl<'a> ProgramStatusState<'a>

Source

pub const IDLE: Self

At rest, ready for the user’s next instruction.

Source

pub const WORKING: Self

Work is in progress.

Source

pub const DONE: Self

Work finished and its result is ready.

Source

pub const BLOCKED: Self

Work requires user input before it can continue.

Source

pub const ERROR: Self

Work failed and stopped.

Source

pub const CLEAR: Self

Remove the addressed record and all descendants.

Source

pub const fn new(name: &'a str) -> Self

Borrow a state name without validation.

Check the terminal’s accepted states before use. The writer accepts nonempty values from [A-Za-z0-9_.,+/=-] within the sequence limit.

Source

pub const fn as_str(self) -> &'a str

Return the state name used on the wire.

Trait Implementations§

Source§

impl<'a> Clone for ProgramStatusState<'a>

Source§

fn clone(&self) -> ProgramStatusState<'a>

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<'a> Copy for ProgramStatusState<'a>

Source§

impl<'a> Debug for ProgramStatusState<'a>

Source§

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

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

impl<'a> Eq for ProgramStatusState<'a>

Source§

impl<'a> Hash for ProgramStatusState<'a>

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<'a> PartialEq for ProgramStatusState<'a>

Source§

fn eq(&self, other: &ProgramStatusState<'a>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for ProgramStatusState<'a>

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
§

impl<T> ErasedDestructor for T
where T: 'static,

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

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.