Struct actix_web::http::header::QualityItem

source ·
pub struct QualityItem<T> {
    pub item: T,
    pub quality: Quality,
}
Expand description

Represents an item with a quality value as defined in RFC 7231 §5.3.1.

§Parsing and Formatting

This wrapper be used to parse header value items that have a q-factor annotation as well as serialize items with a their q-factor.

§Ordering

Since this context of use for this type is header value items, ordering is defined for QualityItems but only considers the item’s quality. Order of appearance should be used as the secondary sorting parameter; i.e., a stable sort over the quality values will produce a correctly sorted sequence.

§Examples

let q_item: QualityItem<String> = "hello;q=0.3".parse().unwrap();
assert_eq!(&q_item.item, "hello");
assert_eq!(q_item.quality, q(0.3));

// note that format is normalized compared to parsed item
assert_eq!(q_item.to_string(), "hello; q=0.3");

// item with q=0.3 is greater than item with q=0.1
let q_item_fallback: QualityItem<String> = "abc;q=0.1".parse().unwrap();
assert!(q_item > q_item_fallback);

Fields§

§item: T

The wrapped contents of the field.

§quality: Quality

The quality (client or server preference) for the value.

Implementations§

source§

impl<T> QualityItem<T>

source

pub fn new(item: T, quality: Quality) -> QualityItem<T>

Constructs a new QualityItem from an item and a quality value.

The item can be of any type. The quality should be a value in the range [0, 1].

source

pub fn max(item: T) -> QualityItem<T>

Constructs a new QualityItem from an item, using the maximum q-value.

source

pub fn min(item: T) -> QualityItem<T>

Constructs a new QualityItem from an item, using the minimum, non-zero q-value.

source

pub fn zero(item: T) -> QualityItem<T>

Constructs a new QualityItem from an item, using zero q-value of zero.

Trait Implementations§

source§

impl<T> Clone for QualityItem<T>
where T: Clone,

source§

fn clone(&self) -> QualityItem<T>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<T> Debug for QualityItem<T>
where T: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> Display for QualityItem<T>
where T: Display,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> FromStr for QualityItem<T>
where T: FromStr,

§

type Err = ParseError

The associated error which can be returned from parsing.
source§

fn from_str( q_item_str: &str, ) -> Result<QualityItem<T>, <QualityItem<T> as FromStr>::Err>

Parses a string s to return a value of this type. Read more
source§

impl<T> PartialEq for QualityItem<T>
where T: PartialEq,

source§

fn eq(&self, other: &QualityItem<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T> PartialOrd for QualityItem<T>
where T: PartialEq,

source§

fn partial_cmp(&self, other: &QualityItem<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl<T> Copy for QualityItem<T>
where T: Copy,

source§

impl<T> Eq for QualityItem<T>
where T: Eq,

source§

impl<T> StructuralPartialEq for QualityItem<T>

Auto Trait Implementations§

§

impl<T> Freeze for QualityItem<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for QualityItem<T>
where T: RefUnwindSafe,

§

impl<T> Send for QualityItem<T>
where T: Send,

§

impl<T> Sync for QualityItem<T>
where T: Sync,

§

impl<T> Unpin for QualityItem<T>
where T: Unpin,

§

impl<T> UnwindSafe for QualityItem<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> CloneToUninit for T
where T: Copy,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more