pub enum Map {
Dynamic(IndexMap<ValueContainer, ValueContainer>),
Fixed(Vec<(ValueContainer, ValueContainer)>),
Structural(Vec<(String, ValueContainer)>),
}Variants§
Dynamic(IndexMap<ValueContainer, ValueContainer>)
Fixed(Vec<(ValueContainer, ValueContainer)>)
Structural(Vec<(String, ValueContainer)>)
Implementations§
Source§impl Map
impl Map
pub fn new(entries: IndexMap<ValueContainer, ValueContainer>) -> Self
pub fn is_structural(&self) -> bool
pub fn has_fixed_size(&self) -> bool
pub fn size(&self) -> usize
pub fn is_empty(&self) -> bool
Sourcepub fn get(&self, key: &ValueContainer) -> Option<&ValueContainer>
pub fn get(&self, key: &ValueContainer) -> Option<&ValueContainer>
Gets a value in the map by reference. Returns None if the key is not found.
Sourcepub fn get_text(&self, key: &str) -> Option<&ValueContainer>
pub fn get_text(&self, key: &str) -> Option<&ValueContainer>
Gets a value in the map, where the key is a string. Returns None if the key is not found
Sourcepub fn has(&self, key: &ValueContainer) -> bool
pub fn has(&self, key: &ValueContainer) -> bool
Checks if the map contains the given key.
Sourcepub fn remove(
&mut self,
key: &ValueContainer,
) -> Result<ValueContainer, MapAccessError>
pub fn remove( &mut self, key: &ValueContainer, ) -> Result<ValueContainer, MapAccessError>
Removes a key from the map, returning the value if it existed.
Sourcepub fn clear(&mut self) -> Result<(), MapAccessError>
pub fn clear(&mut self) -> Result<(), MapAccessError>
Clears all entries in the map, returning an error if the map is not dynamic.
Sourcepub fn get_owned<T: Into<ValueContainer>>(
&self,
key: T,
) -> Option<&ValueContainer>
pub fn get_owned<T: Into<ValueContainer>>( &self, key: T, ) -> Option<&ValueContainer>
Gets a value in the map, taking ownership of the key.
Trait Implementations§
Source§impl From<IndexMap<ValueContainer, ValueContainer>> for Map
impl From<IndexMap<ValueContainer, ValueContainer>> for Map
Source§fn from(map: IndexMap<ValueContainer, ValueContainer>) -> Self
fn from(map: IndexMap<ValueContainer, ValueContainer>) -> Self
Source§impl From<Vec<(ValueContainer, ValueContainer)>> for Map
impl From<Vec<(ValueContainer, ValueContainer)>> for Map
Source§fn from(vec: Vec<(ValueContainer, ValueContainer)>) -> Self
fn from(vec: Vec<(ValueContainer, ValueContainer)>) -> Self
Create a dynamic map from a vector of value containers.
Source§impl<K, V> FromIterator<(K, V)> for Map
impl<K, V> FromIterator<(K, V)> for Map
Source§impl<'a> IntoIterator for &'a Map
impl<'a> IntoIterator for &'a Map
Source§impl<'a> IntoIterator for &'a mut Map
impl<'a> IntoIterator for &'a mut Map
Source§impl IntoIterator for Map
impl IntoIterator for Map
Source§type Item = (OwnedMapKey, ValueContainer)
type Item = (OwnedMapKey, ValueContainer)
Source§type IntoIter = IntoMapIterator
type IntoIter = IntoMapIterator
Source§impl StructuralEq for Map
impl StructuralEq for Map
Source§fn structural_eq(&self, other: &Self) -> bool
fn structural_eq(&self, other: &Self) -> bool
impl CoreValueTrait for Map
impl Eq for Map
impl StructuralPartialEq for Map
Auto Trait Implementations§
impl Freeze for Map
impl !RefUnwindSafe for Map
impl !Send for Map
impl !Sync for Map
impl Unpin for Map
impl !UnwindSafe for Map
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();Source§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.Source§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);