Struct StepId 

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

Step identifier (spine §3, 02 §3).

Author-written ids are a single segment [A-Za-z_][A-Za-z0-9_-]*. :-separated additional segments are reserved for compiler-synthesized ids (handler-embedded human steps such as flow:onUnknown:escalate, macro hygiene prefixes such as set_ssid:field). Synthesized ids never appear in ref paths (RefPath has no : in its grammar).

Implementations

impl StepId

pub fn new(value: impl Into<String>) -> Result<Self, ValidationError>

Validates value against the grammar and constructs the newtype.

pub fn as_str(&self) -> &str

Borrows the underlying string.

pub fn into_string(self) -> String

Consumes the newtype, returning the underlying string.

impl StepId

pub fn is_synthesized(&self) -> bool

true when this id carries a compiler-synthesized : segment (macro hygiene prefix or handler-embedded step id).

Trait Implementations

impl AsRef<str> for StepId

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StepId

fn clone(&self) -> StepId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StepId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StepId

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

Formats the value using the given formatter.

impl Eq for StepId

impl From<StepId> for String

fn from(value: StepId) -> String

Converts to this type from the input type.

impl FromStr for StepId

type Err = ValidationError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

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

impl Hash for StepId

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 JsonSchema for StepId

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(_generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

impl Ord for StepId

fn cmp(&self, other: &StepId) -> 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.

impl PartialEq for StepId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for StepId

fn partial_cmp(&self, other: &StepId) -> 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 Serialize for StepId

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StepId

impl TryFrom<&str> for StepId

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for StepId

type Error = ValidationError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.