Enum pavex::http::header::Entry

pub enum Entry<'a, T>
where T: 'a,
{ Occupied(OccupiedEntry<'a, T>), Vacant(VacantEntry<'a, T>), }
Expand description

A view into a single location in a HeaderMap, which may be vacant or occupied.

Variants§

§

Occupied(OccupiedEntry<'a, T>)

An occupied entry

§

Vacant(VacantEntry<'a, T>)

A vacant entry

Implementations§

§

impl<'a, T> Entry<'a, T>

pub fn or_insert(self, default: T) -> &'a mut T

Ensures a value is in the entry by inserting the default if empty.

Returns a mutable reference to the first value in the entry.

§Panics

This method panics if capacity exceeds max HeaderMap capacity

§Examples
let mut map: HeaderMap<u32> = HeaderMap::default();

let headers = &[
    "content-length",
    "x-hello",
    "Content-Length",
    "x-world",
];

for &header in headers {
    let counter = map.entry(header)
        .or_insert(0);
    *counter += 1;
}

assert_eq!(map["content-length"], 2);
assert_eq!(map["x-hello"], 1);

pub fn or_try_insert(self, default: T) -> Result<&'a mut T, MaxSizeReached>

Ensures a value is in the entry by inserting the default if empty.

Returns a mutable reference to the first value in the entry.

§Errors

This function may return an error if HeaderMap exceeds max capacity

§Examples
let mut map: HeaderMap<u32> = HeaderMap::default();

let headers = &[
    "content-length",
    "x-hello",
    "Content-Length",
    "x-world",
];

for &header in headers {
    let counter = map.entry(header)
        .or_try_insert(0)
        .unwrap();
    *counter += 1;
}

assert_eq!(map["content-length"], 2);
assert_eq!(map["x-hello"], 1);

pub fn or_insert_with<F>(self, default: F) -> &'a mut T
where F: FnOnce() -> T,

Ensures a value is in the entry by inserting the result of the default function if empty.

The default function is not called if the entry exists in the map. Returns a mutable reference to the first value in the entry.

§Examples

Basic usage.

let mut map = HeaderMap::new();

let res = map.entry("x-hello")
    .or_insert_with(|| "world".parse().unwrap());

assert_eq!(res, "world");

The default function is not called if the entry exists in the map.

let mut map = HeaderMap::new();
map.try_insert(HOST, "world".parse().unwrap()).unwrap();

let res = map.try_entry("host")
    .unwrap()
    .or_try_insert_with(|| unreachable!())
    .unwrap();


assert_eq!(res, "world");

pub fn or_try_insert_with<F>( self, default: F, ) -> Result<&'a mut T, MaxSizeReached>
where F: FnOnce() -> T,

Ensures a value is in the entry by inserting the result of the default function if empty.

The default function is not called if the entry exists in the map. Returns a mutable reference to the first value in the entry.

§Examples

Basic usage.

let mut map = HeaderMap::new();

let res = map.entry("x-hello")
    .or_insert_with(|| "world".parse().unwrap());

assert_eq!(res, "world");

The default function is not called if the entry exists in the map.

let mut map = HeaderMap::new();
map.try_insert(HOST, "world".parse().unwrap()).unwrap();

let res = map.try_entry("host")
    .unwrap()
    .or_try_insert_with(|| unreachable!())
    .unwrap();


assert_eq!(res, "world");

pub fn key(&self) -> &HeaderName

Returns a reference to the entry’s key

§Examples
let mut map = HeaderMap::new();

assert_eq!(map.entry("x-hello").key(), "x-hello");

Trait Implementations§

§

impl<'a, T> Debug for Entry<'a, T>
where T: Debug + 'a,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> !Freeze for Entry<'a, T>

§

impl<'a, T> RefUnwindSafe for Entry<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for Entry<'a, T>
where T: Send,

§

impl<'a, T> Sync for Entry<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for Entry<'a, T>

§

impl<'a, T> !UnwindSafe for Entry<'a, T>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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

source§

type Output = T

Should always be Self
source§

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

source§

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>,

source§

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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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