Struct http::uri::PathAndQuery

[+] Show declaration

pub struct PathAndQuery { /* fields omitted */ }

[−] Expand description

Represents the path component of a URI

Methods

impl PathAndQuery[−]

pub fn from_shared(src: Bytes) -> Result<Self, InvalidUriBytes>[−]

Attempt to convert a PathAndQuery from Bytes.

This function will be replaced by a TryFrom implementation once the trait lands in stable.

Examples

extern crate bytes;

use bytes::Bytes;

let bytes = Bytes::from("/hello?world");
let path_and_query = PathAndQuery::from_shared(bytes).unwrap();

assert_eq!(path_and_query.path(), "/hello");
assert_eq!(path_and_query.query(), Some("world"));

pub fn from_static(src: &'static str) -> Self[−]

Convert a PathAndQuery from a static string.

This function will not perform any copying, however the string is checked to ensure that it is valid.

Panics

This function panics if the argument is an invalid path and query.

Examples

let v = PathAndQuery::from_static("/hello?world");

assert_eq!(v.path(), "/hello");
assert_eq!(v.query(), Some("world"));

pub fn path(&self) -> &str[−]

Returns the path component

The path component is case sensitive.

abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
                                       |--------|
                                            |
                                          path

If the URI is * then the path component is equal to *.

Examples

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert_eq!(path_and_query.path(), "/hello/world");

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

Returns the query string component

The query component contains non-hierarchical data that, along with data in the path component, serves to identify a resource within the scope of the URI's scheme and naming authority (if any). The query component is indicated by the first question mark ("?") character and terminated by a number sign ("#") character or by the end of the URI.

abc://username:password@example.com:123/path/data?key=value&key2=value2#fragid1
                                                  |-------------------|
                                                            |
                                                          query

Examples

With a query string component

let path_and_query: PathAndQuery = "/hello/world?key=value&foo=bar".parse().unwrap();

assert_eq!(path_and_query.query(), Some("key=value&foo=bar"));

Without a query string component

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert!(path_and_query.query().is_none());

pub fn as_str(&self) -> &str[−]

Returns the path and query as a string component.

Examples

With a query string component

let path_and_query: PathAndQuery = "/hello/world?key=value&foo=bar".parse().unwrap();

assert_eq!(path_and_query.as_str(), "/hello/world?key=value&foo=bar");

Without a query string component

let path_and_query: PathAndQuery = "/hello/world".parse().unwrap();

assert_eq!(path_and_query.as_str(), "/hello/world");

pub fn into_bytes(self) -> Bytes[−]

Converts this PathAndQuery back to a sequence of bytes

Trait Implementations

impl HttpTryFrom<Bytes> for PathAndQuery[+]

[+] Show hidden undocumented items

type Error = InvalidUriBytes

Associated error with the conversion this implementation represents.

fn try_from(bytes: Bytes) -> Result<Self, Self::Error>

impl<'a> HttpTryFrom<&'a [u8]> for PathAndQuery[+]

[+] Show hidden undocumented items

type Error = InvalidUri

Associated error with the conversion this implementation represents.

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

impl<'a> HttpTryFrom<&'a str> for PathAndQuery[+]

[+] Show hidden undocumented items

type Error = InvalidUri

Associated error with the conversion this implementation represents.

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

impl HttpTryFrom<PathAndQuery> for PathAndQuery[+]

[+] Show hidden undocumented items

type Error = Error

Associated error with the conversion this implementation represents.

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

impl PartialEq<PathAndQuery> for PathAndQuery[+]

[+] Show hidden undocumented items

fn eq(&self, other: &PathAndQuery) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialEq<str> for PathAndQuery[+]

[+] Show hidden undocumented items

fn eq(&self, other: &str) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<'a> PartialEq<PathAndQuery> for &'a str[+]

[+] Show hidden undocumented items

fn eq(&self, other: &PathAndQuery) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<'a> PartialEq<&'a str> for PathAndQuery[+]

[+] Show hidden undocumented items

fn eq(&self, other: &&'a str) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialEq<PathAndQuery> for str[+]

[+] Show hidden undocumented items

fn eq(&self, other: &PathAndQuery) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialEq<String> for PathAndQuery[+]

[+] Show hidden undocumented items

fn eq(&self, other: &String) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl PartialEq<PathAndQuery> for String[+]

[+] Show hidden undocumented items

fn eq(&self, other: &PathAndQuery) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use]

fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl Clone for PathAndQuery[+]

[+] Show hidden undocumented items

fn clone(&self) -> PathAndQuery[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl From<PathAndQuery> for Bytes[+]

[+] Show hidden undocumented items

fn from(src: PathAndQuery) -> Bytes[−]

Performs the conversion.

impl Eq for PathAndQuery

impl PartialOrd<PathAndQuery> for PathAndQuery[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &PathAndQuery) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<str> for PathAndQuery[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &str) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PathAndQuery> for str[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &PathAndQuery) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<&'a str> for PathAndQuery[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &&'a str) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PartialOrd<PathAndQuery> for &'a str[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &PathAndQuery) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<String> for PathAndQuery[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &String) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PartialOrd<PathAndQuery> for String[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &PathAndQuery) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]

fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]

fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]

fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]

fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for PathAndQuery[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for PathAndQuery[+]

[+] Show hidden undocumented items

fn fmt(&self, fmt: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl FromStr for PathAndQuery[+]

[+] Show hidden undocumented items

type Err = InvalidUri

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, InvalidUri>[−]

Parses a string s to return a value of this type.