Enum ClientHint

pub enum ClientHint {
    Ua,
    FullVersion,
    FullVersionList,
    Platform,
    PlatformVersion,
    Arch,
    Bitness,
    Wow64,
    Model,
    Mobile,
    FormFactor,
    Lang,
    SaveData,
    Width,
    ViewportWidth,
    ViewportHeight,
    Dpr,
    DeviceMemory,
    Rtt,
    Downlink,
    Ect,
    PrefersColorScheme,
    PrefersReducedMotion,
    PrefersReducedTransparency,
    PrefersContrast,
    ForcedColors,
}

Variants

Ua

Sec-CH-UA represents a user agent’s branding and version.

FullVersion

Sec-CH-UA-Full-Version represents the user agent’s full version.

FullVersionList

Sec-CH-UA-Full-Version-List represents the full version for each brand in its brands list.

Platform

Sec-CH-UA-Platform represents the platform on which a given user agent is executing.

PlatformVersion

Sec-CH-UA-Platform-Version represents the platform version on which a given user agent is executing.

Arch

Sec-CH-UA-Arch represents the architecture of the platform on which a given user agent is executing.

Bitness

Sec-CH-UA-Bitness represents the bitness of the architecture of the platform on which a given user agent is executing.

Wow64

Sec-CH-UA-WoW64 is used to detect whether or not a user agent binary is running in 32-bit mode on 64-bit Windows.

Model

Sec-CH-UA-Model represents the device on which a given user agent is executing.

Mobile

Sec-CH-UA-Mobile is used to detect whether or not a user agent prefers a «mobile» user experience.

FormFactor

Sec-CH-UA-Form-Factors represents the form-factors of a device, historically represented as a token in the User-Agent string.

Lang

Sec-CH-Lang (or Lang) represents the user’s language preference.

SaveData

Sec-CH-Save-Data (or Save-Data) represents the user agent’s preference for reduced data usage.

Width

Sec-CH-Width gives a server the layout width of the image.

ViewportWidth

Sec-CH-Viewport-Width (or Viewport-Width) is the width of the user’s viewport in CSS pixels.

ViewportHeight

Sec-CH-Viewport-Height represents the user-agent’s current viewport height.

Dpr

Sec-CH-DPR (or DPR) reports the ratio of physical pixels to CSS pixels of the user’s screen.

DeviceMemory

Sec-CH-Device-Memory (or Device-Memory) reveals the approximate amount of memory the current device has in GiB. Because this information could be used to fingerprint users, the value of Device-Memory is intentionally coarse. Valid values are 0.25, 0.5, 1, 2, 4, and 8.

Rtt

Sec-CH-RTT (or RTT) provides the approximate Round Trip Time, in milliseconds, on the application layer. The RTT hint, unlike transport layer RTT, includes server processing time. The value of RTT is rounded to the nearest 25 milliseconds to prevent fingerprinting.

Downlink

Sec-CH-Downlink (or Downlink) expressed in megabits per second (Mbps), reveals the approximate downstream speed of the user’s connection. The value is rounded to the nearest multiple of 25 kilobits per second. Because again, fingerprinting.

Ect

Sec-CH-ECT (or ECT) stands for Effective Connection Type. Its value is one of an enumerated list of connection types, each of which describes a connection within specified ranges of both RTT and Downlink values. Valid values for ECT are 4g, 3g, 2g, and slow-2g.

PrefersColorScheme

Sec-CH-Prefers-Color-Scheme represents the user’s preferred color scheme.

PrefersReducedMotion

Sec-CH-Prefers-Reduced-Motion is used to detect if the user has requested the system minimize the amount of animation or motion it uses.

PrefersReducedTransparency

Sec-CH-Prefers-Reduced-Transparency is used to detect if the user has requested the system minimize the amount of transparent or translucent layer effects it uses.

PrefersContrast

Sec-CH-Prefers-Contrast is used to detect if the user has requested that the web content is presented with a higher (or lower) contrast.

ForcedColors

Sec-CH-Forced-Colors is used to detect if the user agent has enabled a forced colors mode where it enforces a user-chosen limited color palette on the page.

Implementations

impl ClientHint

pub fn is_low_entropy(&self) -> bool

Checks if the client hint is low entropy, meaning that it will be send by default.

pub fn match_header_name(name: &HeaderName) -> Option<ClientHint>

Attempts to convert a HeaderName to a ClientHint.

pub fn iter_header_names(&self) -> impl Iterator<Item = HeaderName>

Return an iterator of all header names for this client hint.

pub fn as_str(&self) -> &'static str

Returns the preferred string representation of the client hint.

Trait Implementations

impl Clone for ClientHint

fn clone(&self) -> ClientHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientHint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientHint

fn deserialize<D>( deserializer: D, ) -> Result<ClientHint, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClientHint

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

Formats the value using the given formatter.

impl FromStr for ClientHint

type Err = ClientHintParsingError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ClientHint, <ClientHint as FromStr>::Err>

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

impl Hash for ClientHint

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

where __H: Hasher,

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 PartialEq for ClientHint

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&HeaderName> for ClientHint

type Error = ClientHintParsingError

The type returned in the event of a conversion error.

fn try_from( name: &HeaderName, ) -> Result<ClientHint, <ClientHint as TryFrom<&HeaderName>>::Error>

Performs the conversion.

impl TryFrom<&str> for ClientHint

type Error = ClientHintParsingError

The type returned in the event of a conversion error.

fn try_from( name: &str, ) -> Result<ClientHint, <ClientHint as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<HeaderName> for ClientHint

type Error = ClientHintParsingError

The type returned in the event of a conversion error.

fn try_from( name: HeaderName, ) -> Result<ClientHint, <ClientHint as TryFrom<HeaderName>>::Error>

Performs the conversion.

impl TryFrom<String> for ClientHint

type Error = ClientHintParsingError

The type returned in the event of a conversion error.

fn try_from( name: String, ) -> Result<ClientHint, <ClientHint as TryFrom<String>>::Error>

Performs the conversion.

impl Copy for ClientHint

impl Eq for ClientHint

impl StructuralPartialEq for ClientHint