Struct routefinder::RouteSpec

pub struct RouteSpec { /* private fields */ }

Routefinder’s representation of the parsed route

This contains both an optional source string (or unique description) and an ordered sequence of Segments

Implementations

impl RouteSpec

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

Retrieve a reference to the original route definition, if this routespec was parsed from a string representation. If this routespec was created another way, this will return None.

pub fn segments(&self) -> &[Segment]

Slice accessor for the component Segments in this RouteSpec

pub fn matches<'path>(&self, path: &'path str) -> Option<Vec<&'path str>>

Returns a vec of captured str slices for this routespec

pub fn template<'route, 'keys, 'captures, 'values>( &'route self, captures: &'captures Captures<'keys, 'values> ) -> Option<ReverseMatch<'keys, 'values, 'captures, 'route>>

populate this route spec with the params and/or wildcard from a Captures, if it matches.

Trait Implementations

impl Clone for RouteSpec

fn clone(&self) -> RouteSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteSpec

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

Formats the value using the given formatter.

impl Display for RouteSpec

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

Formats the value using the given formatter.

impl From<Vec<Segment>> for RouteSpec

fn from(segments: Vec<Segment>) -> Self

Converts to this type from the input type.

impl FromStr for RouteSpec

type Err = String

The associated error which can be returned from parsing.

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

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

impl Ord for RouteSpec

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RouteSpec

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

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

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 TryFrom<&str> for RouteSpec

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for RouteSpec

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for RouteSpec

impl StructuralPartialEq for RouteSpec