Struct BaseUrl 

pub struct BaseUrl { /* private fields */ }

The absolute URL an application is publicly reachable at, like https://example.com.

Relative URLs work anywhere within the site, but rendered content that leaves it (e.g. links and images in emails, feeds, or sitemaps) needs the absolute form, resolved against this base. A base URL is an http or https URL with a host and an optional path prefix (for applications mounted under one, like https://example.com/app), and no query or fragment. The string is parsed at construction, so every value of this type holds a well-formed base.

Register one on the router builder with .base_url(...), read it back with base_url or try_base_url, and resolve paths against it with join:

use topcoat::context::BaseUrl;

let base = BaseUrl::new("https://example.com")?;
assert_eq!(
    base.join("/assets/logo.png"),
    "https://example.com/assets/logo.png"
);

Implementations

impl BaseUrl

pub fn new(url: impl AsRef<str>) -> Result<BaseUrl, BaseUrlError>

Parses a base URL.

The scheme and any trailing slash are normalized, so https://example.com/app/ and https://example.com/app are the same base.

Errors

Returns BaseUrlError if the string is not an absolute http or https URL, or carries a query string or fragment.

pub fn join(&self, path: &str) -> String

Resolves a root-relative path into an absolute URL.

The path is taken as relative to the application root whether or not it starts with a slash: base.join("/assets/logo.png") and base.join("assets/logo.png") produce the same URL. A query string on the path is carried through.

pub fn as_str(&self) -> &str

The base URL as a string, without a trailing slash.

Trait Implementations

impl Clone for BaseUrl

fn clone(&self) -> BaseUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseUrl

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

Formats the value using the given formatter.

impl Display for BaseUrl

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

Formats the value using the given formatter.

impl Eq for BaseUrl

impl From<&BaseUrl> for BaseUrl

fn from(base_url: &BaseUrl) -> BaseUrl

Converts to this type from the input type.

impl FromStr for BaseUrl

type Err = BaseUrlError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<BaseUrl, BaseUrlError>

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

impl PartialEq for BaseUrl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BaseUrl

impl TryFrom<&String> for BaseUrl

type Error = BaseUrlError

The type returned in the event of a conversion error.

fn try_from(url: &String) -> Result<BaseUrl, BaseUrlError>

Performs the conversion.

impl TryFrom<&str> for BaseUrl

type Error = BaseUrlError

The type returned in the event of a conversion error.

fn try_from(url: &str) -> Result<BaseUrl, BaseUrlError>

Performs the conversion.

impl TryFrom<String> for BaseUrl

type Error = BaseUrlError

The type returned in the event of a conversion error.

fn try_from(url: String) -> Result<BaseUrl, BaseUrlError>

Performs the conversion.