Struct SaveData 

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

Available on crate feature http only.

Save-Data client hint: the user agent’s preference for reduced data usage.

Defined by the Save Data API. The header is sent with the value on when the user has opted in to data savings; the canonical “off” state is the absence of the header, though an explicit off is also accepted on decode (both matched ASCII case-insensitively).

Corresponds to ClientHint::SaveData; encoded as Sec-CH-Save-Data.

Example

use rama_http_headers::SaveData;

let save_data = SaveData::on();
assert!(save_data.is_on());

Implementations

impl SaveData

pub const HINT: ClientHint = ClientHint::SaveData

The ClientHint this typed value parser corresponds to.

pub const fn new(enabled: bool) -> SaveData

Create a SaveData hint from a boolean preference.

pub const fn on() -> SaveData

Create a SaveData hint requesting reduced data usage (on).

pub const fn off() -> SaveData

Create a SaveData hint with data savings disabled (off).

pub const fn is_on(self) -> bool

Returns true if reduced data usage is requested.

Trait Implementations

impl Clone for SaveData

fn clone(&self) -> SaveData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SaveData

impl Debug for SaveData

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

Formats the value using the given formatter.

impl Eq for SaveData

impl From<SaveData> for bool

fn from(value: SaveData) -> bool

Converts to this type from the input type.

impl From<bool> for SaveData

fn from(enabled: bool) -> SaveData

Converts to this type from the input type.

impl Hash for SaveData

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 HeaderDecode for SaveData

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for SaveData

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

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

impl PartialEq for SaveData

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

impl TypedHeader for SaveData

fn name() -> &'static HeaderName

The name of this header.