Struct hyper::client::connect::Destination

pub struct Destination { /* fields omitted */ }

A set of properties to describe where and how to try to connect.

This type is passed an argument for the Connect trait.

Methods

impl Destination

pub fn try_from_uri(uri: Uri) -> Result<Self>

Try to convert a Uri into a Destination

Error

Returns an error if the uri contains no authority or no scheme.

pub fn scheme(&self) -> &str

Get the protocol scheme.

pub fn host(&self) -> &str

Get the hostname.

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

Get the port, if specified.

pub fn set_scheme(&mut self, scheme: &str) -> Result<()>

Update the scheme of this destination.

Example

// let mut dst = some_destination...
// Change from "http://"...
assert_eq!(dst.scheme(), "http");

// to "ws://"...
dst.set_scheme("ws");
assert_eq!(dst.scheme(), "ws");

Error

Returns an error if the string is not a valid scheme.

pub fn set_host(&mut self, host: &str) -> Result<()>

Update the host of this destination.

Example

// let mut dst = some_destination...
// Change from "hyper.rs"...
assert_eq!(dst.host(), "hyper.rs");

// to "some.proxy"...
dst.set_host("some.proxy");
assert_eq!(dst.host(), "some.proxy");

Error

Returns an error if the string is not a valid hostname.

pub fn set_port<P>(&mut self, port: P) where
    P: Into<Option<u16>>, 

Update the port of this destination.

Example

// let mut dst = some_destination...
// Change from "None"...
assert_eq!(dst.port(), None);

// to "4321"...
dst.set_port(4321);
assert_eq!(dst.port(), Some(4321));

// Or remove the port...
dst.set_port(None);
assert_eq!(dst.port(), None);

Trait Implementations

impl Clone for Destination

fn clone(&self) -> Destination

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Destination

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

Formats the value using the given formatter.

impl TryFrom<Uri> for Destination

type Error = Error

The type returned in the event of a conversion error.

fn try_from(uri: Uri) -> Result<Self, Self::Error>

Performs the conversion.