Skip to main content

UrlBuilder

Struct UrlBuilder 

Source
pub struct UrlBuilder { /* private fields */ }

Implementations§

Source§

impl UrlBuilder

Source

pub fn absolute_url_for<U>(&self, destination: &U) -> Url
where U: Route,

Create an absolute URL for a route

Source

pub fn relative_url_for<U>(&self, destination: &U) -> String
where U: Route,

Create a relative URL for a route, prefixed with the base URL

Source

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

The prefix added to all relative URLs

Source

pub fn redirect<U>(&self, destination: &U) -> Redirect
where U: Route,

Create a (relative) redirect response to a route

Source

pub fn absolute_redirect<U>(&self, destination: &U) -> Redirect
where U: Route,

Create an absolute redirect response to a route

Source

pub fn new(base: Url, issuer: Option<Url>, assets_base: Option<String>) -> Self

Create a new UrlBuilder from a base URL

§Panics

Panics if the base URL contains a fragment, a query, credentials or isn’t HTTP/HTTPS;

Source

pub fn public_hostname(&self) -> &str

Site public hostname

§Panics

Panics if the base URL does not have a host

Source

pub fn http_base(&self) -> Url

HTTP base

Source

pub fn oidc_issuer(&self) -> Url

OIDC issuer

Source

pub fn oidc_discovery(&self) -> Url

OIDC discovery document URL

Source

pub fn oauth_authorization_endpoint(&self) -> Url

OAuth 2.0 authorization endpoint

Source

pub fn oauth_token_endpoint(&self) -> Url

OAuth 2.0 token endpoint

Source

pub fn oauth_introspection_endpoint(&self) -> Url

OAuth 2.0 introspection endpoint

Source

pub fn oauth_revocation_endpoint(&self) -> Url

OAuth 2.0 revocation endpoint

Source

pub fn oauth_registration_endpoint(&self) -> Url

OAuth 2.0 client registration endpoint

Source

pub fn oauth_device_authorization_endpoint(&self) -> Url

OAuth 2.0 device authorization endpoint

OAuth 2.0 device code link

OAuth 2.0 device code link full URL

Source

pub fn oidc_userinfo_endpoint(&self) -> Url

Source

pub fn jwks_uri(&self) -> Url

JWKS URI

Source

pub fn static_asset(&self, path: String) -> Url

Static asset

Source

pub fn assets_base(&self) -> &str

Static asset base

Source

pub fn graphql_endpoint(&self) -> Url

GraphQL endpoint

Source

pub fn upstream_oauth_callback(&self, id: Ulid) -> Url

Upstream redirect URI

Source

pub fn upstream_oauth_authorize(&self, id: Ulid) -> Url

Upstream authorize URI

Source

pub fn account_management_uri(&self) -> Url

Account management URI

Account recovery link

Trait Implementations§

Source§

impl Clone for UrlBuilder

Source§

fn clone(&self) -> UrlBuilder

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
Source§

impl Debug for UrlBuilder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for UrlBuilder

Source§

impl PartialEq for UrlBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for UrlBuilder

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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