Enum 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§
Implementations§
§impl<'a, T> Entry<'a, T>
impl<'a, T> Entry<'a, T>
pub fn or_insert(self, default: T) -> &'a mut 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>
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 Twhere
F: FnOnce() -> T,
pub fn or_insert_with<F>(self, default: F) -> &'a mut Twhere
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,
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
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§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);