Struct Session 

pub struct Session(/* private fields */);

The execution context for a Tokel expansion.

This struct holds the active Registry and is responsible for evaluating TokelStreams. By default, it is pre-loaded with Tokel’s standard built-in transformers, but it can be customized or strictly sandboxed as needed.

Implementations

impl Session

pub fn new() -> Self

Creates a new Session populated with the default Registry.

This includes all standard Tokel transformers (e.g., identity, case). This is the primary constructor used by standard tokel::stream! invocations.

pub const fn new_with(registry: Registry) -> Self

Creates a Session using a specific, pre-configured Registry.

This is useful if you want to initialize a registry, heavily customize it, and then pass it into the session for execution.

pub fn empty() -> Self

Creates a completely blank Session with an empty Registry.

This session will have no built-in transformers available. It is useful for creating strictly controlled, domain-specific token manipulation APIs where users are only allowed to use custom transformers you explicitly provide.

pub const fn registry(&self) -> &Registry

Borrows the active Registry for this Session.

pub const fn registry_mut(&mut self) -> &mut Registry

Mutably borrows the active Registry for this Session.

This allows you to register new custom transformers or extract state from existing ones during or after the session’s lifecycle.

Trait Implementations

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Session

Returns the “default value” for a type.