Struct headers::common::referer::Referer

pub struct Referer(HeaderValue);

Referer header, defined in RFC7231

The Referer [sic] header field allows the user agent to specify a URI reference for the resource from which the target URI was obtained (i.e., the “referrer”, though the field name is misspelled). A user agent MUST NOT include the fragment and userinfo components of the URI reference, if any, when generating the Referer field value.

ABNF

Referer = absolute-URI / partial-URI

Example values

• http://www.example.org/hypertext/Overview.html

Examples

use headers::Referer;

let r = Referer::from_static("/People.html#tim");

Tuple Fields

0: HeaderValue

Implementations

impl Referer

pub fn from_static(s: &'static str) -> Referer

Create a Referer with a static string.

Panic

Panics if the string is not a legal header value.

Trait Implementations

impl Clone for Referer

fn clone(&self) -> Referer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Referer

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

Formats the value using the given formatter.

impl FromStr for Referer

type Err = InvalidReferer

The associated error which can be returned from parsing.

fn from_str(src: &str) -> Result<Self, Self::Err>

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

impl Header for Referer

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I>(values: &mut I) -> Result<Self, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap.

impl PartialEq for Referer

fn eq(&self, other: &Referer) -> 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 StructuralPartialEq for Referer