pub struct SessionStore(/* private fields */);Expand description
Where server-side session records are stored.
It is a thin wrapper around your chosen storage backend implementation, removing the need to specify the concrete type of the storage backend everywhere in your code.
Implementations§
Source§impl SessionStore
impl SessionStore
Sourcepub fn new<Backend>(backend: Backend) -> Selfwhere
Backend: SessionStorageBackend + 'static,
pub fn new<Backend>(backend: Backend) -> Selfwhere
Backend: SessionStorageBackend + 'static,
Creates a new session store using the provided backend.
Sourcepub async fn create(
&self,
id: &SessionId,
record: SessionRecordRef<'_>,
) -> Result<(), CreateError>
pub async fn create( &self, id: &SessionId, record: SessionRecordRef<'_>, ) -> Result<(), CreateError>
Creates a new session record in the store using the provided ID.
Sourcepub async fn update(
&self,
id: &SessionId,
record: SessionRecordRef<'_>,
) -> Result<(), UpdateError>
pub async fn update( &self, id: &SessionId, record: SessionRecordRef<'_>, ) -> Result<(), UpdateError>
Update the state of an existing session in the store.
It overwrites the existing record with the provided one.
Sourcepub async fn update_ttl(
&self,
id: &SessionId,
ttl: Duration,
) -> Result<(), UpdateTtlError>
pub async fn update_ttl( &self, id: &SessionId, ttl: Duration, ) -> Result<(), UpdateTtlError>
Update the TTL of an existing session record in the store.
It leaves the session state unchanged.
Sourcepub async fn load(
&self,
id: &SessionId,
) -> Result<Option<SessionRecord>, LoadError>
pub async fn load( &self, id: &SessionId, ) -> Result<Option<SessionRecord>, LoadError>
Loads an existing session record from the store using the provided ID.
If a session with the given ID exists, it is returned. If the session
does not exist or has been invalidated (e.g., expired), None is
returned.
Sourcepub async fn delete(&self, id: &SessionId) -> Result<(), DeleteError>
pub async fn delete(&self, id: &SessionId) -> Result<(), DeleteError>
Deletes a session record from the store using the provided ID.
If the session exists, it is removed from the store.
Sourcepub async fn change_id(
&self,
old_id: &SessionId,
new_id: &SessionId,
) -> Result<(), ChangeIdError>
pub async fn change_id( &self, old_id: &SessionId, new_id: &SessionId, ) -> Result<(), ChangeIdError>
Change the session id associated with an existing session record.
The server-side state is left unchanged.
Sourcepub async fn delete_expired(
&self,
batch_size: Option<NonZeroUsize>,
) -> Result<usize, DeleteExpiredError>
pub async fn delete_expired( &self, batch_size: Option<NonZeroUsize>, ) -> Result<usize, DeleteExpiredError>
Deletes expired session records from the store.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for SessionStore
impl !RefUnwindSafe for SessionStore
impl Send for SessionStore
impl Sync for SessionStore
impl Unpin for SessionStore
impl !UnwindSafe for SessionStore
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);