Struct RefPath 

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

Closed-scope reference path of the expression grammar (spine §7, 02 §8.1):

RefPath ::= 'params.' Ident ('.' Ident)*
          | 'env.'    Ident
          | 'vars.'   Ident
          | 'iter.'   Ident
          | 'steps.'  StepIdRef '.' 'output' ('.' Ident)*
          | 'steps.'  StepIdRef '.' 'verdict'

Dotted identifier segments only; array/deep access goes through the jsonPath pure function. secrets.* is reserved for v0.2 and rejected today. StepIdRef deliberately has no :: compiler-synthesized step ids can never be referenced.

Implementations

impl RefPath

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 RefPath

pub fn referenced_step(&self) -> Option<&str>

Returns the referenced upstream step id when this path is rooted at steps. (the syntactic data-dependency answer of 02 §8.1), or None for the other scope roots.

pub fn scope_root(&self) -> &str

Returns the scope root of the path (params, env, vars, iter or steps).

Trait Implementations

impl AsRef<str> for RefPath

fn as_ref(&self) -> &str

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

impl Clone for RefPath

fn clone(&self) -> RefPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RefPath

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RefPath

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

Formats the value using the given formatter.

impl Eq for RefPath

impl From<RefPath> for String

fn from(value: RefPath) -> String

Converts to this type from the input type.

impl FromStr for RefPath

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 RefPath

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 RefPath

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 RefPath

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RefPath

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

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 RefPath

impl TryFrom<&str> for RefPath

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 RefPath

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.