Struct actix_router::Path

pub struct Path<T> { /* private fields */ }

Resource path match information.

If resource path contains variable patterns, Path stores them.

Implementations

impl<T: ResourcePath> Path<T>

pub fn new(path: T) -> Path<T>

pub fn get_ref(&self) -> &T

Returns reference to inner path instance.

pub fn get_mut(&mut self) -> &mut T

Returns mutable reference to inner path instance.

pub fn as_str(&self) -> &str

Returns full path as a string.

pub fn unprocessed(&self) -> &str

Returns unprocessed part of the path.

Returns empty string if no more is to be processed.

pub fn set(&mut self, path: T)

Set new path.

pub fn reset(&mut self)

Reset state.

pub fn skip(&mut self, n: u16)

Skip first n chars in path.

pub fn is_empty(&self) -> bool

Check if there are any matched patterns.

pub fn segment_count(&self) -> usize

Returns number of interpolated segments.

pub fn get(&self, name: &str) -> Option<&str>

Get matched parameter by name without type conversion

pub fn query(&self, key: &str) -> &str

Returns matched parameter by name.

If keyed parameter is not available empty string is used as default value.

pub fn iter(&self) -> PathIter<'_, T>

Return iterator to items in parameter container.

pub fn load<'de, U: Deserialize<'de>>(&'de self) -> Result<U, Error>

Deserializes matching parameters to a specified type U.

Errors

Returns error when dynamic path segments cannot be deserialized into a U type.

Trait Implementations

impl<T: Clone> Clone for Path<T>

fn clone(&self) -> Path<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Path<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Path<T>

fn default() -> Path<T>

Returns the “default value” for a type.

impl<'a, T: ResourcePath> Index<&'a str> for Path<T>

type Output = str

The returned type after indexing.

fn index(&self, name: &'a str) -> &str

Performs the indexing (container[index]) operation.

impl<T: ResourcePath> Index<usize> for Path<T>

type Output = str

The returned type after indexing.

fn index(&self, idx: usize) -> &str

Performs the indexing (container[index]) operation.

impl<T: ResourcePath> Resource for Path<T>

type Path = T

Type of resource’s path returned in resource_path.

fn resource_path(&mut self) -> &mut Path<Self::Path>