pub struct OccupiedEntry<'a, VE: ValueEncoding> { /* private fields */ }
Expand description

A view into a single occupied location in a MetadataMap.

This struct is returned as part of the Entry enum.

Implementations§

source§

impl<'a, VE: ValueEncoding> OccupiedEntry<'a, VE>

source

pub fn key(&self) -> &MetadataKey<VE>

Returns a reference to the entry’s key.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());

if let Entry::Occupied(e) = map.entry("host").unwrap() {
    assert_eq!("host", e.key());
}
source

pub fn get(&self) -> &MetadataValue<VE>

Get a reference to the first value in the entry.

Values are stored in insertion order.

§Panics

get panics if there are no values associated with the entry.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "hello.world".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    assert_eq!(e.get(), &"hello.world");

    e.append("hello.earth".parse().unwrap());

    assert_eq!(e.get(), &"hello.world");
}
source

pub fn get_mut(&mut self) -> &mut MetadataValue<VE>

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

Values are stored in insertion order.

§Panics

get_mut panics if there are no values associated with the entry.

§Examples
let mut map = MetadataMap::default();
map.insert("host", "hello.world".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    e.get_mut().set_sensitive(true);
    assert_eq!(e.get(), &"hello.world");
    assert!(e.get().is_sensitive());
}
source

pub fn into_mut(self) -> &'a mut MetadataValue<VE>

Converts the OccupiedEntry into a mutable reference to the first value.

The lifetime of the returned reference is bound to the original map.

§Panics

into_mut panics if there are no values associated with the entry.

§Examples
let mut map = MetadataMap::default();
map.insert("host", "hello.world".parse().unwrap());
map.append("host", "hello.earth".parse().unwrap());

if let Entry::Occupied(e) = map.entry("host").unwrap() {
    e.into_mut().set_sensitive(true);
}

assert!(map.get("host").unwrap().is_sensitive());
source

pub fn insert(&mut self, value: MetadataValue<VE>) -> MetadataValue<VE>

Sets the value of the entry.

All previous values associated with the entry are removed and the first one is returned. See insert_mult for an API that returns all values.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "hello.world".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    let mut prev = e.insert("earth".parse().unwrap());
    assert_eq!("hello.world", prev);
}

assert_eq!("earth", map.get("host").unwrap());
source

pub fn insert_mult(&mut self, value: MetadataValue<VE>) -> ValueDrain<'_, VE>

Sets the value of the entry.

This function does the same as insert except it returns an iterator that yields all values previously associated with the key.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());
map.append("host", "world2".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    let mut prev = e.insert_mult("earth".parse().unwrap());
    assert_eq!("world", prev.next().unwrap());
    assert_eq!("world2", prev.next().unwrap());
    assert!(prev.next().is_none());
}

assert_eq!("earth", map.get("host").unwrap());
source

pub fn append(&mut self, value: MetadataValue<VE>)

Insert the value into the entry.

The new value is appended to the end of the entry’s value list. All previous values associated with the entry are retained.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    e.append("earth".parse().unwrap());
}

let values = map.get_all("host");
let mut i = values.iter();
assert_eq!("world", *i.next().unwrap());
assert_eq!("earth", *i.next().unwrap());
source

pub fn remove(self) -> MetadataValue<VE>

Remove the entry from the map.

All values associated with the entry are removed and the first one is returned. See remove_entry_mult for an API that returns all values.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());

if let Entry::Occupied(e) = map.entry("host").unwrap() {
    let mut prev = e.remove();
    assert_eq!("world", prev);
}

assert!(!map.contains_key("host"));
source

pub fn remove_entry(self) -> (MetadataKey<VE>, MetadataValue<VE>)

Remove the entry from the map.

The key and all values associated with the entry are removed and the first one is returned. See remove_entry_mult for an API that returns all values.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());

if let Entry::Occupied(e) = map.entry("host").unwrap() {
    let (key, mut prev) = e.remove_entry();
    assert_eq!("host", key.as_str());
    assert_eq!("world", prev);
}

assert!(!map.contains_key("host"));
source

pub fn remove_entry_mult(self) -> (MetadataKey<VE>, ValueDrain<'a, VE>)

Remove the entry from the map.

The key and all values associated with the entry are removed and returned.

source

pub fn iter(&self) -> ValueIter<'_, VE>

Returns an iterator visiting all values associated with the entry.

Values are iterated in insertion order.

§Examples
let mut map = MetadataMap::new();
map.insert("host", "world".parse().unwrap());
map.append("host", "earth".parse().unwrap());

if let Entry::Occupied(e) = map.entry("host").unwrap() {
    let mut iter = e.iter();
    assert_eq!(&"world", iter.next().unwrap());
    assert_eq!(&"earth", iter.next().unwrap());
    assert!(iter.next().is_none());
}
source

pub fn iter_mut(&mut self) -> ValueIterMut<'_, VE>

Returns an iterator mutably visiting all values associated with the entry.

Values are iterated in insertion order.

§Examples
let mut map = MetadataMap::default();
map.insert("host", "world".parse().unwrap());
map.append("host", "earth".parse().unwrap());

if let Entry::Occupied(mut e) = map.entry("host").unwrap() {
    for e in e.iter_mut() {
        e.set_sensitive(true);
    }
}

let mut values = map.get_all("host");
let mut i = values.iter();
assert!(i.next().unwrap().is_sensitive());
assert!(i.next().unwrap().is_sensitive());

Trait Implementations§

source§

impl<'a, VE: Debug + ValueEncoding> Debug for OccupiedEntry<'a, VE>

source§

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

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

impl<'a, 'b: 'a, VE: ValueEncoding> IntoIterator for &'b OccupiedEntry<'a, VE>

§

type Item = &'a MetadataValue<VE>

The type of the elements being iterated over.
§

type IntoIter = ValueIter<'a, VE>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> ValueIter<'a, VE>

Creates an iterator from a value. Read more
source§

impl<'a, 'b: 'a, VE: ValueEncoding> IntoIterator for &'b mut OccupiedEntry<'a, VE>

§

type Item = &'a mut MetadataValue<VE>

The type of the elements being iterated over.
§

type IntoIter = ValueIterMut<'a, VE>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> ValueIterMut<'a, VE>

Creates an iterator from a value. Read more
source§

impl<'a, VE> IntoIterator for OccupiedEntry<'a, VE>
where VE: 'a + ValueEncoding,

§

type Item = &'a mut MetadataValue<VE>

The type of the elements being iterated over.
§

type IntoIter = ValueIterMut<'a, VE>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> ValueIterMut<'a, VE>

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<'a, VE> RefUnwindSafe for OccupiedEntry<'a, VE>
where VE: RefUnwindSafe,

§

impl<'a, VE> Send for OccupiedEntry<'a, VE>
where VE: Send,

§

impl<'a, VE> Sync for OccupiedEntry<'a, VE>
where VE: Sync,

§

impl<'a, VE> Unpin for OccupiedEntry<'a, VE>
where VE: Unpin,

§

impl<'a, VE> !UnwindSafe for OccupiedEntry<'a, VE>

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.

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

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> Same for T

§

type Output = T

Should always be Self
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