pub struct ClientSessionStateMut<'session>(/* private fields */);Expand description
A mutable reference to the client-side state of a session.
Implementations§
Source§impl ClientSessionStateMut<'_>
impl ClientSessionStateMut<'_>
Sourcepub fn get<T: DeserializeOwned>(
&self,
key: &str,
) -> Result<Option<T>, ValueDeserializationError>
pub fn get<T: DeserializeOwned>( &self, key: &str, ) -> Result<Option<T>, ValueDeserializationError>
Get the value associated with key from the client-side state.
If the value is not found, None is returned.
If the value is found, but it cannot be deserialized into the expected type, an error is returned.
Sourcepub fn get_raw<'a>(&'a self, key: &str) -> Option<&'a Value>
pub fn get_raw<'a>(&'a self, key: &str) -> Option<&'a Value>
Get the raw JSON value associated with key from the client-side state.
Sourcepub fn insert<T, Key>(
&mut self,
key: Key,
value: T,
) -> Result<Option<Value>, ValueSerializationError>
pub fn insert<T, Key>( &mut self, key: Key, value: T, ) -> Result<Option<Value>, ValueSerializationError>
Insert a value in the client-side state for the given key.
If the key already exists, the value is updated and the old raw value is returned. If the value cannot be serialized, an error is returned.
Sourcepub fn insert_raw<Key>(&mut self, key: Key, value: Value) -> Option<Value>
pub fn insert_raw<Key>(&mut self, key: Key, value: Value) -> Option<Value>
Insert a value in the client-side state for the given key.
If the key already exists, the value is updated and the old value is returned.
Sourcepub fn remove<T: DeserializeOwned>(
&mut self,
key: &str,
) -> Result<Option<T>, ValueDeserializationError>
pub fn remove<T: DeserializeOwned>( &mut self, key: &str, ) -> Result<Option<T>, ValueDeserializationError>
Remove the value associated with key from the client-side state.
If the key exists, the removed value is returned. If the removed value cannot be serialized, an error is returned.
Sourcepub fn remove_raw(&mut self, key: &str) -> Option<Value>
pub fn remove_raw(&mut self, key: &str) -> Option<Value>
Remove the value associated with key from the client-side state.
If the key exists, the removed value is returned.
Sourcepub fn clear(&mut self)
pub fn clear(&mut self)
Remove all key-value pairs from the client-side state.
This doesn’t invalidate the session—you must invoke Session::invalidate
if you want to delete the session altogether.
Auto Trait Implementations§
impl<'session> Freeze for ClientSessionStateMut<'session>
impl<'session> !RefUnwindSafe for ClientSessionStateMut<'session>
impl<'session> !Send for ClientSessionStateMut<'session>
impl<'session> !Sync for ClientSessionStateMut<'session>
impl<'session> Unpin for ClientSessionStateMut<'session>
impl<'session> !UnwindSafe for ClientSessionStateMut<'session>
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);