Struct Session 

pub struct Session {
    interpreter: Interpreter,
    captured_stdout: Option<Arc<Mutex<Vec<u8>>>>,
    captured_stderr: Option<Arc<Mutex<Vec<u8>>>>,
}

Fields

interpreter: Interpreter

captured_stdout: Option<Arc<Mutex<Vec<u8>>>>

Shared stdout capture buffer (only set for captured-output sessions).

captured_stderr: Option<Arc<Mutex<Vec<u8>>>>

Shared stderr capture buffer (only set for captured-output sessions).

Implementations

impl Session

pub fn new() -> Self

pub fn new_with_captured_output() -> Self

Create a session that captures stdout and stderr into in-memory buffers instead of writing to the process streams. Use captured_stdout() and captured_stderr() to retrieve the accumulated output.

pub fn captured_stdout(&self) -> String

Return all output written to the interpreter’s stdout writer so far.

Only meaningful when the session was created with new_with_captured_output(). For sessions using real stdio this will return an empty string.

pub fn captured_stderr(&self) -> String

Return all output written to the interpreter’s stderr writer so far.

Only meaningful when the session was created with new_with_captured_output().

pub fn eval_expr(&mut self, expr: &Expr) -> Result<EvalOutput, SessionError>

pub fn eval_source(&mut self, source: &str) -> Result<EvalOutput, SessionError>

pub fn auto_print(&mut self, value: &RValue)

Auto-print a value by calling print() through the interpreter. This dispatches to S3 methods (print.matrix, print.data.frame, etc.) unlike Display which just formats as a flat vector.

pub fn eval_file( &mut self, path: impl AsRef<Path>, ) -> Result<EvalOutput, SessionError>

pub fn interpreter(&self) -> &Interpreter

pub fn format_last_traceback(&self) -> Option<String>

Format the last error’s traceback for display, or None if there is none.

pub fn render_error(&self, err: &SessionError) -> String

Render an error with its traceback (if any).

pub fn set_option(&self, name: &str, value: RValue)

Set a per-interpreter R option (same effect as options(name = value) in R).

pub fn sync_terminal_width(&self)

Update getOption("width") to match the current terminal width.

Uses crossterm when the repl feature is enabled (most accurate, since crossterm is already linked for the REPL). Falls back to the lighter terminal_size crate when only the terminal-size feature is enabled. Returns 80 columns when neither is available.

pub fn generate_rd_docs(dir: &Path) -> Result<usize, Error>

Generate .Rd documentation files for all documented builtins.

Creates the output directory if it doesn’t exist, then writes one .Rd file per primary builtin name. Returns the number of files written.

pub fn interrupt_flag(&self) -> Arc<AtomicBool>

Return a clone of the interpreter’s interrupt flag. The caller (or a signal handler) can set it to true to interrupt the current computation.

pub fn install_signal_handler(&self) -> Result<()>

Register a SIGINT handler that sets the interpreter’s interrupt flag instead of killing the process. Returns Ok(()) on success.

This should be called once at startup (e.g. before entering the REPL). On platforms where SIGINT is not available this is a no-op.

Trait Implementations

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.