Skip to main content

InMemorySessionKv

Struct InMemorySessionKv 

Source
pub struct InMemorySessionKv { /* private fields */ }
Expand description

Bounded in-memory store.

The optional shared_bytes counter is where a server-wide KV budget across live sessions attaches: the per-session and aggregate reservations are taken together and both unwound if either fails.

Implementations§

Source§

impl InMemorySessionKv

Source

pub fn new(limits: SessionKvLimits) -> Self

Source

pub fn with_shared_budget( limits: SessionKvLimits, budget: SharedKvBudget, ) -> Self

Source

pub fn used_bytes(&self) -> u64

Retained bytes: payloads plus keys plus per-entry overhead.

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Trait Implementations§

Source§

impl Default for InMemorySessionKv

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for InMemorySessionKv

Releasing on drop is what makes the aggregate budget usable for session lifetime: a session ends by having its store dropped, not by removing every key first, so without this the reservation of every ended session would be held forever and the budget would ratchet to its cap.

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl SessionKvStore for InMemorySessionKv

Source§

fn get(&self, key: &[u16]) -> Result<Option<Vec<u16>>, SessionKvError>

Ok(None) is an absent key. A present entry holding a serialized null returns Ok(Some(..)) — callers distinguish the two.
Source§

fn has(&self, key: &[u16]) -> Result<bool, SessionKvError>

Source§

fn set(&self, key: &[u16], payload: &[u16]) -> Result<(), SessionKvError>

Source§

fn remove(&self, key: &[u16]) -> Result<bool, SessionKvError>

Ok(true) when an entry existed and was removed.
Source§

fn scan( &self, after: Option<&[u16]>, prefix: &[u16], max_scan: usize, ) -> Result<SessionKvPage, SessionKvError>

Keys in UTF-16 code-unit order, strictly after after when given and starting with prefix. Scans at most max_scan keys; matching is exact code units, with no normalization or path semantics.
Source§

fn limits(&self) -> SessionKvLimits

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more