Skip to main content

SessionState

Struct SessionState 

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

Shared session state that can be cloned across requests.

Uses atomic operations for thread-safe state transitions. Includes a type-safe extensions map for storing session-scoped data like authentication claims.

§Example

use tower_mcp::SessionState;

#[derive(Debug, Clone)]
struct UserClaims {
    user_id: String,
    role: String,
}

let session = SessionState::new();

// Store auth claims in the session
session.insert(UserClaims {
    user_id: "user123".to_string(),
    role: "admin".to_string(),
});

// Retrieve claims later
if let Some(claims) = session.get::<UserClaims>() {
    assert_eq!(claims.role, "admin");
}

Implementations§

Source§

impl SessionState

Source

pub fn new() -> Self

Create a new session in the Uninitialized phase

Source

pub fn insert<T: Send + Sync + Clone + 'static>(&self, val: T)

Insert a value into the session extensions.

This is typically used by auth middleware to store claims that can be checked by capability filters.

§Example
use tower_mcp::SessionState;

let session = SessionState::new();
session.insert(42u32);
assert_eq!(session.get::<u32>(), Some(42));
Source

pub fn get<T: Send + Sync + Clone + 'static>(&self) -> Option<T>

Get a cloned value from the session extensions.

Returns None if no value of the given type has been inserted or if the lock cannot be acquired.

§Example
use tower_mcp::SessionState;

let session = SessionState::new();
session.insert("hello".to_string());
assert_eq!(session.get::<String>(), Some("hello".to_string()));
assert_eq!(session.get::<u32>(), None);
Source

pub fn phase(&self) -> SessionPhase

Get the current session phase

Source

pub fn is_initialized(&self) -> bool

Check if the session is initialized (operation phase)

Source

pub fn mark_initializing(&self) -> bool

Transition from Uninitialized to Initializing. Called after responding to an initialize request. Returns true if the transition was successful.

Source

pub fn mark_initialized(&self) -> bool

Transition from Initializing to Initialized. Called when receiving an initialized notification. Returns true if the transition was successful.

Source

pub fn is_request_allowed(&self, method: &str) -> bool

Check if a request method is allowed in the current phase. Per spec:

  • Before initialization: only initialize and ping are valid
  • During all phases: ping is always valid

Trait Implementations§

Source§

impl Clone for SessionState

Source§

fn clone(&self) -> SessionState

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for SessionState

Source§

fn default() -> Self

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

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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