Struct flowcore::model::route::Route

pub struct Route { /* private fields */ }

A Route defines a particular location within the flow hierarchy and can be used to refer to a function, flow, input or output uniquely

Implementations

impl Route

Route is used to locate Processes (Flows or Functions), their IOs and sub-elements of a data structure within the flow hierarchy

Examples “/my-flow” -> The flow called “my-flow, anchored at the root of the hierarchy, i.e. the context “/my-flow/sub-flow” -> A flow called “sub-flow” that is within “my-flow” “/my-flow/sub-flow/function” -> A function called “function” within “sub-flow” “/my-flow/sub-flow/function/input_1” -> An IO called “input_1” of “function” “/my-flow/sub-flow/function/input_1/1” -> An array element at index 1 of the Array output from “input_1” “/my-flow/sub-flow/function/input_2/part_a” -> A part of the Json structure output by “input_2” called “part_a”

pub fn sub_route_of(&self, other: &Route) -> Option<Route>

sub_route_of returns an Option<Route> indicating if self is a subroute of other (i.e. self is a longer route to an element under the other route) Return values None - self is not a sub-route of other (e.g. (“/my-route1”, “/my-route2”) (e.g. (“/my-route1”, “/my-route1/something”) Some(Route::from(“”)) - self and other are equal (e.g. (“/my-route1”, “/my-route1”) Some(Route::from(diff)) - self is a sub-route of other - with diff added (e.g. (“/my-route1/something”, “/my-route1”)

pub fn insert<R: AsRef<str>>(&mut self, sub_route: R) -> &Self

Insert another Route at the front of this Route

pub fn extend(&mut self, sub_route: &Route) -> &Self

Extend a Route by appending another Route to the end, adding the ‘/’ separator if needed

pub fn pop(&self) -> (Cow<'_, Route>, Option<Route>)

Return the Route that is one level up, if it exists Example: /context/function/output/subroute -> /context/function/output

pub fn without_trailing_array_index(&self) -> (Cow<'_, Route>, usize, bool)

Return the io Route without a trailing number (array index) and if it has one or not If the trailing number was present then return the route with a trailing ‘/’

pub fn is_array_selector(&self) -> bool

Return true if the Route selects an element from an array

pub fn depth(&self) -> usize

Return the depth of the Route used to specify types and subtypes such as “” -> 0 “string” -> 0 “array/string” -> 1 “array/array/string” -> 2

pub fn is_empty(&self) -> bool

Return true if this Route is empty, false otherwise

pub fn parse_subroute(&self) -> Result<RouteType>

Parse the Route into the specific type of sub-route

pub fn parent(&self, name: &Name) -> String

Return the Route the parent of the supplied Name

Trait Implementations

impl AsRef<str> for Route

fn as_ref(&self) -> &str

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

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Default for Route

fn default() -> Route

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Route

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Route

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

Formats the value using the given formatter.

impl From<&String> for Route

fn from(name: &Name) -> Self

Converts to this type from the input type.

impl From<&str> for Route

fn from(string: &str) -> Self

Converts to this type from the input type.

impl From<String> for Route

fn from(string: String) -> Self

Converts to this type from the input type.

impl FromStr for Route

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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

impl Hash for Route

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 Route

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Route

fn eq(&self, other: &Route) -> 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 PartialOrd for Route

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Route

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

Serialize this value into the given Serde serializer.

impl Validate for Route

fn validate(&self) -> Result<()>

Validate that a deserialized model data structure is valid for use

impl Eq for Route

impl StructuralEq for Route

impl StructuralPartialEq for Route