Struct http::uri::Builder

source ·
pub struct Builder { /* private fields */ }
Expand description

A builder for Uris.

This type can be used to construct an instance of Uri through a builder pattern.

Implementations§

source§

impl Builder

source

pub fn new() -> Builder

Creates a new default instance of Builder to construct a Uri.

§Examples

let uri = uri::Builder::new()
    .scheme("https")
    .authority("hyper.rs")
    .path_and_query("/")
    .build()
    .unwrap();
source

pub fn scheme<T>(self, scheme: T) -> Self
where Scheme: TryFrom<T>, <Scheme as TryFrom<T>>::Error: Into<Error>,

Set the Scheme for this URI.

§Examples

let mut builder = uri::Builder::new();
builder.scheme("https");
source

pub fn authority<T>(self, auth: T) -> Self

Set the Authority for this URI.

§Examples

let uri = uri::Builder::new()
    .authority("tokio.rs")
    .build()
    .unwrap();
source

pub fn path_and_query<T>(self, p_and_q: T) -> Self

Set the PathAndQuery for this URI.

§Examples

let uri = uri::Builder::new()
    .path_and_query("/hello?foo=bar")
    .build()
    .unwrap();
source

pub fn build(self) -> Result<Uri, Error>

Consumes this builder, and tries to construct a valid Uri from the configured pieces.

§Errors

This function may return an error if any previously configured argument failed to parse or get converted to the internal representation. For example if an invalid scheme was specified via scheme("!@#%/^") the error will be returned when this function is called rather than when scheme was called.

Additionally, the various forms of URI require certain combinations of parts to be set to be valid. If the parts don’t fit into any of the valid forms of URI, a new error is returned.

§Examples

let uri = Uri::builder()
    .build()
    .unwrap();

Trait Implementations§

source§

impl Debug for Builder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Builder

source§

fn default() -> Builder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.