Struct peace_core::FlowId

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

Identifier or name of a process flow.

Examples are "dev_env" and "artifact" in the following snippet:

peace dev_env discover # StatesDiscoverCmd
peace dev_env status   # StatesCurrentStoredDisplayCmd
peace dev_env deploy   # EnsureCmd
peace dev_env clean    # CleanCmd

peace artifact discover # StatesDiscoverCmd
peace artifact status   # StatesCurrentStoredDisplayCmd
peace artifact publish  # EnsureCmd

Must begin with a letter or underscore, and contain only letters, numbers, and underscores.

Examples

The following are all examples of valid FlowIds:

let _snake = flow_id!("snake_case");
let _camel = flow_id!("camelCase");
let _pascal = flow_id!("PascalCase");

Implementations

impl FlowId

pub fn new(s: &'static str) -> Result<Self, FlowIdInvalidFmt<'_>>

Returns a new FlowId if the given &str is valid.

Most users should use the flow_id! macro as this provides compile time checks and returns a const value.

pub fn is_valid_id(proposed_id: &str) -> bool

Returns whether the provided &str is a valid station identifier.

Methods from Deref<Target = Cow<'static, str>>

pub fn is_borrowed(&self) -> bool

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

Returns true if the data is borrowed, i.e. if to_mut would require additional work.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow = Cow::Borrowed("moo");
assert!(cow.is_borrowed());

let bull: Cow<'_, str> = Cow::Owned("...moo?".to_string());
assert!(!bull.is_borrowed());

pub fn is_owned(&self) -> bool

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

Returns true if the data is owned, i.e. if to_mut would be a no-op.

Examples

#![feature(cow_is_borrowed)]
use std::borrow::Cow;

let cow: Cow<'_, str> = Cow::Owned("moo".to_string());
assert!(cow.is_owned());

let bull = Cow::Borrowed("...moo?");
assert!(!bull.is_owned());

Trait Implementations

impl Clone for FlowId

fn clone(&self) -> FlowId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlowId

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

Formats the value using the given formatter.

impl Deref for FlowId

type Target = Cow<'static, str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for FlowId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FlowId

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

Formats the value using the given formatter.

impl FromStr for FlowId

type Err = FlowIdInvalidFmt<'static>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FlowId, FlowIdInvalidFmt<'static>>

Parses a string s to return a value of this type.

impl Hash for FlowId

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 PartialEq for FlowId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Presentable for FlowId

fn present<'output, 'life0, 'life1, 'async_trait, PR>( &'life0 self, presenter: &'life1 mut PR ) -> Pin<Box<dyn Future<Output = Result<(), PR::Error>> + 'async_trait>>

where PR: Presenter<'output> + 'async_trait, Self: 'async_trait, 'output: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Presents this data type to the user.

impl Serialize for FlowId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&'static str> for FlowId

type Error = FlowIdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: &'static str) -> Result<FlowId, FlowIdInvalidFmt<'static>>

Performs the conversion.

impl TryFrom<String> for FlowId

type Error = FlowIdInvalidFmt<'static>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<FlowId, FlowIdInvalidFmt<'static>>

Performs the conversion.

impl Eq for FlowId

impl StructuralPartialEq for FlowId