Struct Url 

pub struct Url { /* private fields */ }

When configuring fronting, some configurations will require a specific backend host to be used for the request to be properly reverse proxied.

This type only describes a host and its configured front domains - it carries no rotation state. A crate::Client tracks, per configured host, which front (if any) is currently in use; see crate::rotation::RotationManager.

Implementations

impl Url

pub fn new<U: IntoUrl>(url: U, fronts: Option<Vec<U>>) -> Result<Self, Error>

Create a new FrontedUrl instance with the given something that can be parsed as a URL and optional tunneling domains

pub fn parse(s: &str) -> Result<Self, ParseError>

Parse an absolute URL from a string.

pub fn inner_url(&self) -> &Url

Returns the underlying URL

pub fn has_front(&self) -> bool

Returns true if the URL has a front domain set

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

Return the string representation of the first configured front host (domain or IP address) for this URL, if any.

This does not reflect any client’s front-rotation state - it is only meaningful before rotation has happened, or for hosts with a single configured front. For the front a crate::Client is actually using, see its rotation-aware accessors instead.

pub fn fronts(&self) -> Option<&[Url]>

Returns the fronts

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

Return the string representation of the host (domain or IP address) for this URL, if any.

pub fn as_str(&self) -> &str

Return the serialization of this URL.

This is fast since that serialization is already stored in the inner url::Url struct. Note that this does not reflect any client’s front-rotation state.

pub fn scheme(&self) -> &str

Return the scheme of this URL, lower-cased, as an ASCII string without the ‘:’ delimiter.

pub fn query_pairs(&self) -> Parse<'_>

Parse the URL’s query string, if any, as application/x-www-form-urlencoded and return an iterator of (key, value) pairs.

pub fn query_pairs_mut(&mut self) -> Serializer<'_, UrlQuery<'_>>

Manipulate this URL’s query string, viewed as a sequence of name/value pairs in application/x-www-form-urlencoded syntax.

pub fn set_query(&mut self, query: Option<&str>)

Change this URL’s query string. If query is None, this URL’s query string will be cleared.

pub fn set_path(&mut self, path: &str)

Change this URL’s path.

pub fn set_scheme(&mut self, scheme: &str)

Change this URL’s scheme.

pub fn set_host(&mut self, host: &str)

Change this URL’s host.

Removing the host (calling this with None) will also remove any username, password, and port number.

pub fn set_port(&mut self, port: u16)

Change this URL’s port number.

Note that default port numbers are not reflected in the serialization.

If this URL is cannot-be-a-base, does not have a host, or has the file scheme; do nothing and return Err.

pub fn path_segments(&self) -> Option<Split<'_, char>>

Return an object with methods to manipulate this URL’s path segments.

Return Err(()) if this URL is cannot-be-a-base.

pub fn path_segments_mut(&mut self) -> Result<PathSegmentsMut<'_>, ()>

Return an object with methods to manipulate this URL’s path segments.

Return Err(()) if this URL is cannot-be-a-base.

Trait Implementations

impl AsMut<Url> for Url

fn as_mut(&mut self) -> &mut Url

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Url> for Url

fn as_ref(&self) -> &Url

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Url

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Url

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

Formats the value using the given formatter.

impl Display for Url

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

Formats the value using the given formatter.

impl Eq for Url

impl From<&Url> for Url

fn from(url: &Url) -> Self

Converts to this type from the input type.

impl From<Url> for Url

fn from(val: Url) -> Self

Converts to this type from the input type.

impl From<Url> for Url

fn from(url: Url) -> Self

Converts to this type from the input type.

impl FromStr for Url

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for Url

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoUrl for Url

fn to_url(self) -> Result<Url, ParseError>

Parse as a valid FrontedUrl

fn as_str(&self) -> &str

Returns the string representation of the URL.

impl PartialEq for Url

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Url