Struct tonic::metadata::OccupiedEntry

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

A view into a single occupied location in a MetadataMap.

This struct is returned as part of the Entry enum.

Methods

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

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());
}

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");
}

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());
}

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());

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());

Important traits for ValueDrain<'a, VE>

impl<'a, VE: ValueEncoding> Iterator for ValueDrain<'a, VE> type Item = MetadataValue<VE>;

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());

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());

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"));

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"));

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.

Important traits for ValueIter<'a, VE>

impl<'a, VE: ValueEncoding> Iterator for ValueIter<'a, VE> where
    VE: 'a,  type Item = &'a MetadataValue<VE>;

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());
}

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

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

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

Formats the value using the given formatter.

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

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?

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

Creates an iterator from a value.

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?

Important traits for ValueIter<'a, VE>

impl<'a, VE: ValueEncoding> Iterator for ValueIter<'a, VE> where
    VE: 'a,  type Item = &'a MetadataValue<VE>;

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

Creates an iterator from a value.

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?

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

Creates an iterator from a value.