Struct headers::common::user_agent::UserAgent

pub struct UserAgent(HeaderValueString);

User-Agent header, defined in RFC7231

The User-Agent header field contains information about the user agent originating the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use. A user agent SHOULD send a User-Agent field in each request unless specifically configured not to do so.

ABNF

User-Agent = product *( RWS ( product / comment ) )
product         = token ["/" product-version]
product-version = token

Example values

• CERN-LineMode/2.15 libwww/2.17b3
• Bunnies

Notes

• The parser does not split the value

Example

use headers::UserAgent;

let ua = UserAgent::from_static("hyper/0.12.2");

Tuple Fields

0: HeaderValueString

Implementations

impl UserAgent

pub fn from_static(src: &'static str) -> UserAgent

Create a UserAgent from a static string.

Panic

Panics if the static string is not a legal header value.

pub fn as_str(&self) -> &str

View this UserAgent as a &str.

Trait Implementations

impl Clone for UserAgent

fn clone(&self) -> UserAgent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserAgent

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

Formats the value using the given formatter.

impl Display for UserAgent

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

Formats the value using the given formatter.

impl FromStr for UserAgent

type Err = InvalidUserAgent

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 Hash for UserAgent

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 Header for UserAgent

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 Ord for UserAgent

fn cmp(&self, other: &UserAgent) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for UserAgent

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

fn partial_cmp(&self, other: &UserAgent) -> 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 Eq for UserAgent

impl StructuralPartialEq for UserAgent