Struct primitives::util::ApiUrl

pub struct ApiUrl(_);

A safe Url to use in REST API calls.

It makes sure to always end the Url with /, however it doesn’t check for the existence of a file, e.g. /path/a-file.html

Underneath it uses url::Url, so all the validation from there is enforced, with additional validation which doesn’t allow having:

• Scheme different that http & https
• Non-base urls like data: & mailto:
• Fragment, e.g. #fragment
• Query, e.g. ?query_param=value, ?query_param, ?query=value&...., etc.

Implementations

impl ApiUrl

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

pub fn join(&self, endpoint: &str) -> Result<Url, ParseError>

The Endpoint of which we want to get an url to (strips prefixed / from the endpoint), which can can include:

• path
• query
• fragments - usually should not be used for requesting API resources from server

This method does not check if a file is present

This method strips the starting / of the endpoint, if there is one

pub fn to_url(&self) -> Url

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for ApiUrl

fn clone(&self) -> ApiUrl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiUrl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiUrl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiUrl

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

Formats the value using the given formatter.

impl From<ApiUrl> for Url

fn from(api_url: ApiUrl) -> Self

Converts to this type from the input type.

impl FromStr for ApiUrl

type Err = Error

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 ApiUrl

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 Ord for ApiUrl

fn cmp(&self, other: &ApiUrl) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<ApiUrl> for ApiUrl

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<ApiUrl> for ApiUrl

fn partial_cmp(&self, other: &ApiUrl) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ApiUrl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Url> for ApiUrl

type Error = Error

The type returned in the event of a conversion error.

fn try_from(url: Url) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ApiUrl

impl StructuralEq for ApiUrl

impl StructuralPartialEq for ApiUrl