Skip to main content

Endpoint

Struct Endpoint

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

Expand description

A canonical absolute hierarchical base URL whose path always ends in /.

Implementations§

impl Endpoint

pub fn parse(input: &str) -> Result<Self, EndpointError>

Parses and canonicalizes an endpoint.

The input must be an absolute hierarchical URL with a host and without a query or fragment. Its path is an endpoint prefix, not a Worldspace path. A trailing slash is appended when absent so RFC 3986 relative-reference resolution preserves the final prefix segment. The supplied scheme is preserved; scheme and transport security are deployment concerns.

pub fn as_url(&self) -> &Url

Returns the canonical base URL.

pub fn route(&self, route: Route) -> Url

Resolves one fixed v1 route below this endpoint prefix.

pub fn recognize(&self, candidate: &Url) -> Option<Route>

Recognizes an exact standard route below this endpoint.

Query strings, fragments, additional path segments, and Worldspace paths are not route components and therefore never match.

Trait Implementations§

impl Clone for Endpoint

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Endpoint

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

Formats the value using the given formatter. Read more

impl Display for Endpoint

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

Formats the value using the given formatter. Read more

impl Eq for Endpoint

impl PartialEq for Endpoint

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Endpoint

impl TryFrom<&str> for Endpoint

type Error = EndpointError

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Endpoint

impl RefUnwindSafe for Endpoint

impl Send for Endpoint

impl Sync for Endpoint

impl Unpin for Endpoint

impl UnsafeUnpin for Endpoint

impl UnwindSafe for Endpoint

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.