Struct http_req::uri::Uri

pub struct Uri<'a> { /* private fields */ }

Representation of Uniform Resource Identifier

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.host(), Some("foo.com"));

Implementations

impl<'a> Uri<'a>

pub fn scheme(&self) -> &str

Returns scheme of this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.scheme(), "https");

pub fn user_info(&self) -> Option<&str>

Returns information about the user included in this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.user_info(), Some("user:info"));

pub fn host(&self) -> Option<&str>

Returns host of this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.host(), Some("foo.com"));

Examples found in repository

examples/request_builder_get.rs (line 9)

fn main() {
    //Parses a URI and assigns it to a variable `addr`.
    let addr: Uri = Uri::try_from("https://www.rust-lang.org/learn").unwrap();

    //Connects to a remote host. Uses information from `addr`.
    let stream = TcpStream::connect((addr.host().unwrap(), addr.corr_port())).unwrap();

    //Opens a secure connection over TlsStream. This is required due to use of `https` protocol.
    let mut stream = tls::Config::default()
        .connect(addr.host().unwrap_or(""), stream)
        .unwrap();

    //Container for a response's body.
    let mut writer = Vec::new();

    //Adds a header `Connection: Close`.
    let response = RequestBuilder::new(&addr)
        .header("Connection", "Close")
        .send(&mut stream, &mut writer)
        .unwrap();

    println!("Status: {} {}", response.status_code(), response.reason());
    println!("Headers: {}", response.headers());
    //println!("{}", String::from_utf8_lossy(&writer));
}

pub fn host_header(&self) -> Option<String>

Returns host of this Uri to use in a header.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.host_header(), Some("foo.com:12".to_string()));

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

Returns port of this Uri

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.port(), Some(12));

pub fn corr_port(&self) -> u16

Returns port corresponding to this Uri. Returns default port if it hasn’t been set in the uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.corr_port(), 12);

Examples found in repository

examples/request_builder_get.rs (line 9)

fn main() {
    //Parses a URI and assigns it to a variable `addr`.
    let addr: Uri = Uri::try_from("https://www.rust-lang.org/learn").unwrap();

    //Connects to a remote host. Uses information from `addr`.
    let stream = TcpStream::connect((addr.host().unwrap(), addr.corr_port())).unwrap();

    //Opens a secure connection over TlsStream. This is required due to use of `https` protocol.
    let mut stream = tls::Config::default()
        .connect(addr.host().unwrap_or(""), stream)
        .unwrap();

    //Container for a response's body.
    let mut writer = Vec::new();

    //Adds a header `Connection: Close`.
    let response = RequestBuilder::new(&addr)
        .header("Connection", "Close")
        .send(&mut stream, &mut writer)
        .unwrap();

    println!("Status: {} {}", response.status_code(), response.reason());
    println!("Headers: {}", response.headers());
    //println!("{}", String::from_utf8_lossy(&writer));
}

pub fn path(&self) -> Option<&str>

Returns path of this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.path(), Some("/bar/baz"));

pub fn query(&self) -> Option<&str>

Returns query of this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.query(), Some("query"));

pub fn fragment(&self) -> Option<&str>

Returns fragment of this Uri.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.fragment(), Some("fragment"));

pub fn resource(&self) -> &str

Returns resource Uri points to.

Example

use http_req::uri::Uri;
use std::convert::TryFrom;

let uri: Uri = Uri::try_from("https://user:info@foo.com:12/bar/baz?query#fragment").unwrap();;
assert_eq!(uri.resource(), "/bar/baz?query#fragment");

Trait Implementations

impl<'a> Clone for Uri<'a>

fn clone(&self) -> Uri<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Uri<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Uri<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Uri<'a>

fn eq(&self, other: &Uri<'a>) -> 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<'a> TryFrom<&'a str> for Uri<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> StructuralPartialEq for Uri<'a>