Struct ReasonPhrase

pub struct ReasonPhrase(/* private fields */);

A reason phrase in an HTTP/1 response.

Clients

For clients, a ReasonPhrase will be present in the extensions of the http::Response returned for a request if the reason phrase is different from the canonical reason phrase for the response’s status code. For example, if a server returns HTTP/1.1 200 Awesome, the ReasonPhrase will be present and contain Awesome, but if a server returns HTTP/1.1 200 OK, the response will not contain a ReasonPhrase.

use hyper::{Client, Uri};
use hyper::ext::ReasonPhrase;

let res = Client::new().get(Uri::from_static("http://example.com/non_canonical_reason")).await?;

// Print out the non-canonical reason phrase, if it has one...
if let Some(reason) = res.extensions().get::<ReasonPhrase>() {
    println!("non-canonical reason: {}", std::str::from_utf8(reason.as_bytes()).unwrap());
}

Servers

When a ReasonPhrase is present in the extensions of the http::Response written by a server, its contents will be written in place of the canonical reason phrase when responding via HTTP/1.

Implementations

impl ReasonPhrase

pub fn as_bytes(&self) -> &[u8]

Gets the reason phrase as bytes.

pub const fn from_static(reason: &'static [u8]) -> Self

Converts a static byte slice to a reason phrase.

Trait Implementations

impl AsRef<[u8]> for ReasonPhrase

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ReasonPhrase

fn clone(&self) -> ReasonPhrase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReasonPhrase

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

Formats the value using the given formatter.

impl From<ReasonPhrase> for Bytes

fn from(reason: ReasonPhrase) -> Self

Converts to this type from the input type.

impl Hash for ReasonPhrase

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ReasonPhrase

fn cmp(&self, other: &ReasonPhrase) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ReasonPhrase

fn eq(&self, other: &ReasonPhrase) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ReasonPhrase

fn partial_cmp(&self, other: &ReasonPhrase) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<&[u8]> for ReasonPhrase

type Error = InvalidReasonPhrase

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Bytes> for ReasonPhrase

type Error = InvalidReasonPhrase

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for ReasonPhrase

type Error = InvalidReasonPhrase

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for ReasonPhrase

type Error = InvalidReasonPhrase

The type returned in the event of a conversion error.

fn try_from(reason: Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ReasonPhrase

impl StructuralPartialEq for ReasonPhrase

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes