Struct WebUrl

pub struct WebUrl { /* private fields */ }

A web-based URL.

Format

All web-based URLs will be in the format: scheme://host:port/path?query#fragment. This is a sub-set of RFC 3986.

The port, query, and fragment are all optional. The path will never be empty and will always start with a ‘/’.

Implementations

impl WebUrl

Construction

pub unsafe fn new<S>( url: S, scheme_len: u32, host_end: u32, ip: Option<IPAddress>, port_end: u32, port: Option<u16>, path_end: u32, query_end: u32, ) -> Self

where S: Into<String>,

Creates a new web-based URL.

Safety

The parameters must be valid.

impl WebUrl

Properties

pub fn len(&self) -> usize

Gets the length.

pub fn is_empty(&self) -> bool

Checks if the url is empty.

impl WebUrl

Display

pub fn as_str(&self) -> &str

Gets the URL string.

impl WebUrl

Fragment

pub fn fragment(&self) -> Option<Fragment<'_>>

Gets the optional fragment.

impl WebUrl

Fragment Mutation

pub fn set_fragment<'a, F>(&mut self, fragment: F)

where F: Into<Option<Fragment<'a>>>,

Sets the fragment.

pub fn with_fragment<'a, F>(self, fragment: F) -> Self

where F: Into<Option<Fragment<'a>>>,

Sets the fragment.

impl WebUrl

Host

pub fn host(&self) -> HostRef<'_>

Gets the host reference.

impl WebUrl

Path

pub fn path(&self) -> Path<'_>

Gets the path.

impl WebUrl

Port

pub fn port(&self) -> Option<u16>

Gets the optional port.

impl WebUrl

Query

pub fn query(&self) -> Option<Query<'_>>

Gets the optional query.

impl WebUrl

Query Parameter Mutations

pub fn add_param<'a, P>(&mut self, param: P)

where P: Into<Param<'a>>,

Adds the query param.

pub fn with_param<'a, P>(self, param: P) -> Self

where P: Into<Param<'a>>,

Adds the query param.

impl WebUrl

Scheme

pub fn scheme(&self) -> Scheme<'_>

Gets the scheme.

Trait Implementations

impl AsRef<str> for WebUrl

fn as_ref(&self) -> &str

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

impl Clone for WebUrl

fn clone(&self) -> WebUrl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebUrl

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

Formats the value using the given formatter.

impl Display for WebUrl

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

Formats the value using the given formatter.

impl FromStr for WebUrl

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 WebUrl

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 WebUrl

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for WebUrl

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for WebUrl

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<String> for WebUrl

type Error = (Error, String)

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for WebUrl