Struct websocket::header::Quality

[+] Show declaration

pub struct Quality(pub u16);

[−] Expand description

Represents a quality used in quality values.

Can be created with the q function.

Implementation notes

The quality value is defined as a number between 0 and 1 with three decimal places. This means there are 1000 possible values. Since floating point numbers are not exact and the smallest floating point data type (f32) consumes four bytes, hyper uses an u16 value to store the quality internally. For performance reasons you may set quality directly to a value between 0 and 1000 e.g. Quality(532) matches the quality q=0.532.

RFC7231 Section 5.3.1 gives more information on quality values in HTTP header fields.

Trait Implementations

impl Clone for Quality[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> Quality[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Quality

impl Debug for Quality[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Quality[+]

[+] Show hidden undocumented items

pub fn default() -> Quality[−]

Returns the “default value” for a type.

impl Display for Quality[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for Quality

impl Ord for Quality[+]

[+] Show hidden undocumented items

pub fn cmp(&self, other: &Quality) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

#[must_use]pub fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use]pub fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self[−]

Restrict a value to a certain interval.

impl PartialEq<Quality> for Quality[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &Quality) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Quality) -> bool[−]

This method tests for !=.

impl PartialOrd<Quality> for Quality[+]

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &Quality) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use]pub fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use]pub fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use]pub fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use]pub fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Quality

impl StructuralPartialEq for Quality