Skip to main content

Session

Struct Session 

Source
pub struct Session {
    pub session_id: Uuid,
    pub tenant_id: TenantId,
    pub user_id: UserId,
    pub client_id: Option<String>,
    pub session_type_id: Option<Uuid>,
    pub enabled_capabilities: Option<Value>,
    pub metadata: Option<Value>,
    pub lifecycle_state: LifecycleState,
    pub share_token: Option<SecretString>,
    pub created_at: OffsetDateTime,
    pub updated_at: OffsetDateTime,
}
Expand description

A chat session: the top-level container that groups a conversation’s messages, tenant/user ownership, backend plugin binding, and lifecycle.

Debug is implemented manually to redact share_token — it is a cryptographic bearer secret that grants read-only access to the session and must never appear in logs, tracing spans, or test output.

Fields§

§session_id: Uuid

Unique session identifier (primary key).

§tenant_id: TenantId

Tenant that owns the session; all queries are scoped by this value.

§user_id: UserId

End-user who created the session (opaque string from the auth token).

§client_id: Option<String>

Optional client identifier (e.g., app/device) that initiated the session.

§session_type_id: Option<Uuid>

Session type this session is bound to; determines which backend plugin handles messages and which capabilities are exposed. May be None for session types that haven’t been configured yet.

§enabled_capabilities: Option<Value>

Capability values (from the Capability schema declared by the plugin) actually enabled for this session — typed as JSON because the shape is plugin-defined. Use CapabilityValue for structured access.

§metadata: Option<Value>

Opaque per-session metadata (client-defined). Chat Engine never interprets this field beyond storing/retrieving it. Also used internally to persist memory_strategy, retention_policy, and share_expires_at under reserved keys.

§lifecycle_state: LifecycleState

Current lifecycle state (active / archived / soft_deleted / hard_deleted).

§share_token: Option<SecretString>

Cryptographically-random token granting read-only access to a shared view of this session. Present only while sharing is active.

§created_at: OffsetDateTime

Creation timestamp (UTC, RFC3339 on the wire).

§updated_at: OffsetDateTime

Last-modified timestamp (UTC, RFC3339 on the wire).

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Session

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Session

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Session

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Session

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.