Struct Session 

pub struct Session {

    pub version: u32,
    pub recent: Vec<PathBuf>,
    pub recent_sortings: Vec<PathBuf>,
    pub workspace: Workspace,
    pub dark: Option<bool>,
    pub tune_suggested: bool,
    pub accent: Option<Rgb>,
    pub dark_plots: bool,
    pub explore: ExploreSession,
    pub panel_widths: BTreeMap<String, f32>,
    pub panel_open: BTreeMap<String, bool>,
    pub servers: Vec<ServerProfile>,
    pub results_dir: Option<PathBuf>,
    pub runtime: Option<String>,
    pub reopen_last: bool,
}

Fields

version: u32

recent: Vec<PathBuf>

recent_sortings: Vec<PathBuf>

workspace: Workspace

dark: Option<bool>

Some(true): dark, Some(false): light, None: follow the system.

tune_suggested: bool

“Tune this device” was suggested (once, at the first launch).

accent: Option<Rgb>

The accent the user picked (None: dsp-kitchen’s lime). Saved as "#rrggbb"; a number (0xRRGGBB) or a colour that does not parse still reads.

dark_plots: bool

Keep plots dark in the light theme.

explore: ExploreSession

panel_widths: BTreeMap<String, f32>

Widths (heights for bottom panels) of resizable panels, by key (explore.left, …).

panel_open: BTreeMap<String, bool>

Side panels shown or hidden, by key (sorting.left, …).

servers: Vec<ServerProfile>

Servers (dspk serve) the user works with (Settings).

results_dir: Option<PathBuf>

Where results fetched from servers go (None: Session::default_results_dir).

runtime: Option<String>

The compute runtime (wgpu, cuda, cpu; None: the first that is compiled in). Takes effect at the next start.

reopen_last: bool

Open the last recording when the app starts (default off: the start screen).

Implementations

impl Session

pub const VERSION: u32 = 1

pub fn new() -> Self

pub fn default_results_dir() -> PathBuf

Results fetched from servers by default: ~/dspk/remote (the home folder, or the current one when there is no home).

pub fn results_dir(&self) -> PathBuf

Where results fetched from servers go.

pub fn recipes_dir() -> Option<PathBuf>

The user’s recipe library: <config>/dspk-app/recipes/.

pub fn path() -> Option<PathBuf>

pub fn document_path() -> Option<PathBuf>

The session document of the open work (views, op chains, linked sortings), next to the preferences: current-session.json. An agent edits it; the app picks the edits up.

pub fn load(path: Option<&Path>) -> Self

The saved session; else the Slint app’s recent files; else an empty one.

pub fn save(&self, path: Option<&Path>) -> Result<()>

pub fn forget_recent(&mut self, path: &Path)

Forgets path from the recent recordings and sortings.

pub fn clear_recent(&mut self)

Forgets every recent recording and sorting.

pub fn push_recent(&mut self, path: &Path)

path becomes the newest recent recording.

pub fn push_recent_sorting(&mut self, path: &Path)

path becomes the newest recent sorting folder.

Trait Implementations

impl Clone for Session

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Session

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

Formats the value using the given formatter.

impl Default for Session

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Session

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Session

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Session