Struct RawUserAgentInfo

pub struct RawUserAgentInfo<S: Default + AsRef<str>> {
    pub user_agent: Option<S>,
    pub client_hints: ClientHints<S>,
}

A container housing both the user-agent string and the client hint headers.

Useful for the scenarios where you will use either information from client hints if it exists, and if not fall back to user agent string.

Fields

user_agent: Option<S>

The “old style” of a single UA string.

client_hints: ClientHints<S>

User-Agent client hints.

Implementations

impl<S: AsRef<str> + Default> RawUserAgentInfo<S>

pub fn set_ua_field_from_header(&mut self, key: &str, value: Option<S>)

Checks if key matches a user agent header, in which case it sets the value accordingly. TODO(tor): make it generic over different header types.

pub fn populate_event_headers(&self, headers: &mut Headers)

Convert user-agent info to HTTP headers as stored in the Request interface.

This function does not overwrite any pre-existing headers.

pub fn is_empty(&self) -> bool

Returns true, if neither a user agent nor client hints are available.

impl RawUserAgentInfo<String>

pub const USER_AGENT: &'static str = "User-Agent"

The name of the user agent HTTP header.

pub fn as_deref(&self) -> RawUserAgentInfo<&str>

Converts to a borrowed RawUserAgentInfo.

impl<'a> RawUserAgentInfo<&'a str>

pub fn from_headers(headers: &'a Headers) -> Self

Computes a borrowed RawUserAgentInfo from the given HTTP headers.

This extracts both the user agent as well as client hints if available. Use is_empty to check whether information could be extracted.

Trait Implementations

impl<S: Clone + Default + AsRef<str>> Clone for RawUserAgentInfo<S>

fn clone(&self) -> RawUserAgentInfo<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Default + AsRef<str>> Debug for RawUserAgentInfo<S>

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

Formats the value using the given formatter.

impl<S: Default + Default + AsRef<str>> Default for RawUserAgentInfo<S>

fn default() -> RawUserAgentInfo<S>

Returns the “default value” for a type.

impl<'de, S> Deserialize<'de> for RawUserAgentInfo<S>

where S: Deserialize<'de> + Default + AsRef<str>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<S: PartialEq + Default + AsRef<str>> PartialEq for RawUserAgentInfo<S>

fn eq(&self, other: &RawUserAgentInfo<S>) -> 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<S> Serialize for RawUserAgentInfo<S>

where S: Serialize + Default + AsRef<str>,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: Default + AsRef<str>> StructuralPartialEq for RawUserAgentInfo<S>