Skip to main content

SidSession

Struct SidSession 

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

On-disk representation of a single interactive agent session.

See the module-level documentation for an overview of the session lifecycle.

Implementations§

Source§

impl SidSession

Source

pub fn create(config_root: &Path<'_>) -> Result<Self, SError>

Create a fresh session under the default sessions root for config_root.

§Errors

Returns an error when the sessions directory cannot be created or a unique session identifier cannot be allocated.

Source

pub fn create_compacted( config_root: &Path<'_>, provenance: CompactionProvenance, ) -> Result<Self, SError>

Create a compacted continuation session linked to a parent via provenance.

§Errors

Returns an error when the sessions directory cannot be created or a unique session identifier cannot be allocated.

Source

pub fn resume(config_root: &Path<'_>, spec: &str) -> Result<Self, SError>

Resume an existing session identified by spec.

spec can be an absolute path to a session directory, a path to its session.json metadata file, or a bare session name relative to the default sessions root.

§Errors

Returns an error when the session directory does not exist or its metadata cannot be read.

Source

pub fn id(&self) -> &str

Return the session’s unique identifier (a timestamp-based string).

Source

pub fn sessions_root(&self) -> &PathBuf

Return the parent directory that contains all session directories.

Source

pub fn root(&self) -> &PathBuf

Return the on-disk root directory for this session.

Source

pub fn compaction_provenance(&self) -> Option<&CompactionProvenance>

Return the compaction provenance if this session was created via compaction.

Source

pub fn transcript_path(&self) -> PathBuf

Return the path to the transcript JSON file for this session.

Source

pub fn read_bash_state(&self) -> Result<Option<String>, SError>

Read the saved bash session state, if any.

Returns Ok(None) when no state file exists or the file is empty.

§Errors

Returns an error on I/O failure.

Source

pub fn write_bash_state(&self, state: &str) -> Result<(), SError>

Persist bash session state to disk for later resumption.

§Errors

Returns an error on I/O failure.

Trait Implementations§

Source§

impl Debug for SidSession

Source§

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

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

impl Drop for SidSession

Source§

fn drop(&mut self)

Executes the destructor for this 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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