Skip to main content

Path

Struct Path 

Source
pub struct Path<P: PathSpec>(pub P::Captures);
Expand description

Extracts typed path captures from the URL.

The extractor reads parts.uri.path() directly and splits it on demand, so there’s no per-request Vec<String> allocation. When the router has a configured prefix, the byte length of that prefix is stored in extensions as PathPrefixOffset so this extractor can skip past it.

§Example

async fn get_user(Path((id,)): Path<path!("users" / u32)>) -> Json<User> {
    // id: u32, extracted from /users/42
}

Tuple Fields§

§0: P::Captures

Trait Implementations§

Source§

impl<P> FromRequestParts for Path<P>

Source§

type Error = (StatusCode, String)

The error type returned when extraction fails.
Source§

fn from_request_parts(parts: &Parts) -> Result<Self, Self::Error>

Extract this type from the request parts.

Auto Trait Implementations§

§

impl<P> Freeze for Path<P>
where <P as PathSpec>::Captures: Freeze,

§

impl<P> RefUnwindSafe for Path<P>

§

impl<P> Send for Path<P>
where <P as PathSpec>::Captures: Send,

§

impl<P> Sync for Path<P>
where <P as PathSpec>::Captures: Sync,

§

impl<P> Unpin for Path<P>
where <P as PathSpec>::Captures: Unpin,

§

impl<P> UnsafeUnpin for Path<P>
where <P as PathSpec>::Captures: UnsafeUnpin,

§

impl<P> UnwindSafe for Path<P>
where <P as PathSpec>::Captures: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<B, C, R, H> Serves<VersionedApi<B, C, R>> for H
where R: ApiSpec, H: Serves<R>,

Source§

fn register(self, router: &mut Router)

Register all handlers into the router.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> IsEndpoint<T> for T