Struct XClacksOverhead 

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

Available on crate feature http only.

X-Clacks-Overhead header implementation

A non-standardised HTTP header based upon the fictional work of the late, great, Sir Terry Pratchett. The header commemorates influential figures in computing and technology by cycling through a predefined list of names.

Use the XClacksOverhead::new constructor when using it with a response header adder layer or something similar. This way you get each response a different header.

Credits

Original implementation inspired by work from Xe. See: https://xclacksoverhead.org/home/about

Examples

use rama_http_headers::exotic::XClacksOverhead;

// Time-based rotation through commemorated names
let header = XClacksOverhead::new();

// Parse from a string
let header: XClacksOverhead = "GNU Terry Pratchett".parse().unwrap();

// Compile-time constant
let header = XClacksOverhead::from_static("GNU Dennis Ritchie");

Implementations

impl XClacksOverhead

pub fn new() -> XClacksOverhead

Construct a new XClacksOverhead header with a name selected based on current epoch time.

The name changes once per day (UTC).

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

Construct an XClacksOverhead from a static string.

Panic

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

pub fn as_str(&self) -> &str

Trait Implementations

impl Clone for XClacksOverhead

fn clone(&self) -> XClacksOverhead

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XClacksOverhead

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

Formats the value using the given formatter.

impl Default for XClacksOverhead

fn default() -> XClacksOverhead

Returns the “default value” for a type.

impl Display for XClacksOverhead

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

Formats the value using the given formatter.

impl FromStr for XClacksOverhead

type Err = InvalidXClacksOverhead

The associated error which can be returned from parsing.

fn from_str( src: &str, ) -> Result<XClacksOverhead, <XClacksOverhead as FromStr>::Err>

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

impl Hash for XClacksOverhead

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 XClacksOverhead

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

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

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for XClacksOverhead

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

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

Restrict a value to a certain interval.

impl PartialEq for XClacksOverhead

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

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

fn name() -> &'static HeaderName

The name of this header.

impl Eq for XClacksOverhead

impl StructuralPartialEq for XClacksOverhead