Struct RunId 

pub struct RunId(/* private fields */);

The identity of one run of an external program

A command can run several programs at the same time, and the lines of those programs then reach the presenter interleaved. Every ProcessEvent carries this value so that a consumer can put a line back with the run that produced it, group the output of one program, and know when that program ended.

The identity is Clawless’s own, and it counts runs. It is not the ProcessId that the operating system assigns, which names the program while it runs and which the operating system reuses afterwards. A run has an identity before the program starts and keeps it after the program ended, which is what an event stream needs.

Examples

use clawless_core::event::process::RunId;

let first = RunId::next();
let second = RunId::next();

assert_ne!(first, second);

Implementations

impl RunId

pub fn next() -> Self

Returns an identity that no earlier call returned

Process::run calls this once per run, so a command that runs a program does not need it. A test that stands in for a run builds its events with identities from here.

The counter wraps after 2^64 runs. An application that started a program every nanosecond would reach that point after more than five hundred years, so the wrap is not a case that callers handle.

Examples

use clawless_core::event::process::RunId;

let id = RunId::next();

assert_eq!(id, id);

pub fn get(&self) -> u64

Returns the identity as a number

A consumer that keys a map or a widget by the run reads the number here.

Examples

use clawless_core::event::process::RunId;

let id = RunId::next();

assert_eq!(id.get(), id.get());

Trait Implementations

impl Clone for RunId

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for RunId

impl Debug for RunId

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

Formats the value using the given formatter.

impl Display for RunId

Shows the identity for a reader

The text is the number alone, so that a log line can name the run without the punctuation that Debug adds.

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

Formats the value using the given formatter.

impl Eq for RunId

impl Hash for RunId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RunId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RunId

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RunId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RunId