Struct SessionDoc 

pub struct SessionDoc {
    pub dspk_session: u32,
    pub graph: GraphDoc,
    pub recipes: Recipes,
    pub epochs: Vec<EpochDoc>,
    pub placements: Vec<Placement>,
    pub event_sets: Vec<EventSetDoc>,
    pub views: Vec<ViewDoc>,
    pub active_view: Option<String>,
}

The whole session.

Fields

dspk_session: u32

Document version; must equal SESSION_VERSION.

graph: GraphDoc

The processing graph (the Pipeline canvas).

recipes: Recipes

The recipes the graph uses, by name (copies of library recipes, or made here).

epochs: Vec<EpochDoc>

Marked spans of the recordings.

placements: Vec<Placement>

Where recordings sit on the session’s time.

event_sets: Vec<EventSetDoc>

Event sets drawn over the recordings’ traces.

views: Vec<ViewDoc>

Every view, in the order they are listed: compiled from graph (a document with views and no graph gets one on load).

active_view: Option<String>

Id of the view shown (and edited by default).

Implementations

impl SessionDoc

pub fn from_json(text: &str) -> Result<Self, SessionError>

pub fn normalize(&mut self)

A graph for a document with views only, then the views from the graph. Views still named the old default way (file · /source/path) take their source’s name.

pub fn compile(&mut self)

The views from the graph; the active view stays when it is still one, else the first.

pub fn normalized(self) -> Self

The document as written by Self::from_json (graph and compiled views).

pub fn load(path: &Path) -> Result<Self, SessionError>

Reads a document (JSON).

pub fn to_json(&self) -> String

The canonical form: pretty JSON with every default written out.

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

Writes the canonical JSON (through a temporary file, so a reader never sees half of it).

pub fn json_schema() -> String

JSON Schema of the document (for agents and editors).

pub fn view(&self, id: &str) -> Option<&ViewDoc>

pub fn view_mut(&mut self, id: &str) -> Option<&mut ViewDoc>

pub fn active(&self) -> Option<&ViewDoc>

pub fn new_view_id(&self) -> String

A view id not used yet (v1, v2, …), by any view or node.

pub fn new_op_id(&self, node: &Node) -> String

An op id not used yet by any node, from the op’s name (iir, iir1, …).

Trait Implementations

impl Clone for SessionDoc

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 SessionDoc

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

Formats the value using the given formatter.

impl Default for SessionDoc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SessionDoc

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SessionDoc

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionDoc

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 SessionDoc