Enum ark_api::http_request::Url

pub enum Url {
    Static(&'static str),
    StaticDomain {
        domain: &'static str,
        path: Cow<'static, str>,
    },
}

URL for HTTP requests

This is intentionally quite restricted to use static domains and protocols for security and simplicity purposes

Variants

Static(&'static str)

Fully static full URL

This is required to start with https:// protocol

StaticDomain

Fields

domain: &'static str

Static domain of the URL

Example: ark.embark.dev

path: Cow<'static, str>

Optional dynamic URL path under the domain.

Example: /guide/getting-started/system-reqs.html

Note: This must start with /

URL with static domain and static or dynamic path

Implementations

impl Url

pub const fn const_from_str(url: &'static str) -> Self

Create a new URL from static string

This is required to start with https:// protocol, but this is currently not validated at compile-time

Example

const TARGET: Url = Url::const_from_str("https://google.com/search?q=rust")

pub const fn const_with_path(domain: &'static str, path: &'static str) -> Self

Create a new URL from a static domain and path

Example

const TARGET: Url = Url::const_with_path("google.com", "/search?q=rust")

pub fn join_path(&self, extra_path: &str) -> Self

Create a new URL with an existing one as base and append the new path in the end

Trait Implementations

impl Clone for Url

fn clone(&self) -> Url

Returns a copy 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 PartialEq<Url> for Url

fn eq(&self, other: &Url) -> 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 StructuralPartialEq for Url