Struct StateLoadOption 

pub struct StateLoadOption {
    pub clean_state: bool,
    pub boot_commands_path: Option<PathBuf>,
    pub state_folder: Option<PathBuf>,
    pub model_file: Option<PathBuf>,
    pub trace_logs_filename: Option<String>,
    pub level: Option<LogLevel>,
    pub logfile_level: Option<LogLevel>,
    pub logging_prefix: Option<LogFormat>,
    pub read_only_state: bool,
    pub settings_global_path: Option<PathBuf>,
    pub settings_runtime_defaults_path: Option<PathBuf>,
}

Programmatic startup options for an embedded GammaLoop session.

The resolved state folder is the explicit state_folder, otherwise the folder named by the boot card, otherwise ./gammaloop_state. A saved, manifested folder is deserialized; a missing, empty, or unmanifested folder starts a blank in-memory state. Loading a blank state does not create or save the folder by itself.

read_only_state prevents GammaLoop-managed writes to the active state tree, not arbitrary filesystem writes: explicit exports elsewhere and external processes such as the ! shell command remain outside that boundary. clean_state removes the resolved path and therefore cannot be combined with read-only mode.

Fields

clean_state: bool

Remove the resolved state folder before loading so the session starts from a blank state.

boot_commands_path: Option<PathBuf>

Optional run card whose settings and commands are applied during boot.

state_folder: Option<PathBuf>

State folder to load, defaulting to ./gammaloop_state when omitted.

model_file: Option<PathBuf>

Optional model file that replaces the saved model when loading an existing state.

trace_logs_filename: Option<String>

Optional trace-log filename for the loaded session.

level: Option<LogLevel>

Terminal log-level override for the loaded session.

logfile_level: Option<LogLevel>

File log-level override for the loaded session.

logging_prefix: Option<LogFormat>

Prefix format used for emitted log records.

read_only_state: bool

Prevent writes inside the active state folder for the lifetime of the session.

settings_global_path: Option<PathBuf>

Optional TOML file whose global settings override the state or boot card.

settings_runtime_defaults_path: Option<PathBuf>

Optional TOML file supplying the session’s default runtime settings.

Implementations

impl StateLoadOption

pub fn load(self) -> Result<LoadedState>

Resolve, initialize, and load an embedded GammaLoop session.

For an existing manifested state this restores the saved model, processes, settings, run history, and integrand backends. model_file is an override only on that saved-state path. For a missing or unmanifested path the method creates a blank state in memory instead. When supplied, the boot run history and settings overrides are applied before this method returns, so loading can mutate the domain state and can perform command-specific external writes.

This method initializes process-global GammaLoop/Symbolica services and tracing. It never automatically persists the returned state. It fails when the state or settings cannot be read or validated, startup initialization fails, a boot command fails or requests exit, or the requested clean/read-only combination is inconsistent.

Trait Implementations

impl Clone for StateLoadOption

fn clone(&self) -> StateLoadOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateLoadOption

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

Formats the value using the given formatter.

impl Default for StateLoadOption

fn default() -> StateLoadOption

Returns the “default value” for a type.

impl PartialEq for StateLoadOption

fn eq(&self, other: &StateLoadOption) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StateLoadOption