Struct imgix::Url

pub struct Url { /* fields omitted */ }

Primary structure used to generate imgix URLs.

An imgix URL is comprised of four components:

• scheme - the scheme being used (https by default).
• domain - the imgix domain, i.e. example.imgix.net.
• path - the path to the image file.
• query - the query string constructed from params.

            domain
        ┌──────┴──────┐
https://www.example.com/image/path.png/?w=320&h=640
└─┬─┘                  └──────┬───────┘ └────┬────┘
scheme                      path           params

Methods

impl Url

pub fn new(domain: &'static str) -> Self

Constructs a new Url given a domain.

Panics

This constructor will fail if the domain is an empty string.

pub fn domain(self, h: &str) -> Self

Sets the domain value (i.e. "example.domain.com").

Panics

This method panics if the domain h is an empty string.

pub fn path(self, r: &str) -> Self

Sets the path value to the image file (i.e. 'image/path.png').

Panics

This method panics if the path string r is empty (i.e. "").

pub fn param(self, k: &'static str, v: &'static str) -> Self

Sets an arbitrary key-value parameter (i.e. k='w', v='100' or k='fit', v='crop').

Panics

This method panics if the key k or the value v is an empty string.

pub fn params(self, p: &[(&'static str, &'static str)]) -> Self

Sets an arbitrary number of key-value parameters.

Panics

This method panics if any key k or any value v is an empty string.

pub fn lib(self, l: &str) -> Self

Sets the lib or library.

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

Sets the signing token.

pub fn scheme(self, s: Scheme) -> Self

pub fn join(&self) -> String

Joins the components of a Url (i.e. scheme + domain + path + params) where the resulting string has the following form:

{scheme}://{domain}/{path}?{lib}{query}

This function will only join the components of a Url if a path has been specified.

Panics

This function will panic if the image path has not been specified. (i.e. if the path is None).

pub fn join_params(p: &[(&'static str, &'static str)]) -> String

Joins a list of key-value parameter pairs.

Examples

Panics

This function panics if any key k or any value v is an empty string.

Trait Implementations

impl Default for Url

fn default() -> Self

By default a imgix URL is created with its scheme set to Scheme::Https and the lib value set to the version specified in this library's Cargo.toml