Skip to main content

Session

Struct Session 

Source
pub struct Session {
    pub bpm: u32,
    pub sig: (u8, u8),
    pub phrase: u32,
    pub seed: u64,
    pub scale: Option<(PitchRoot, ScaleMode)>,
    /* private fields */
}
Expand description

Live session state.

Fields§

§bpm: u32

Current BPM.

§sig: (u8, u8)

Current time signature (numerator, denominator).

§phrase: u32

How many cycles a phrase spans. Changes are quantised to it, so 1 is “apply at the next cycle” and 16 is “apply at the top of the phrase”.

§seed: u64

seed (§8.8) — salts every generative construct in the buffer.

§scale: Option<(PitchRoot, ScaleMode)>

Default scale for degree patterns (scale directive).

Implementations§

Source§

impl Session

Source

pub fn new() -> Self

Source

pub fn piece(&self) -> Option<&Piece>

The resolved piece, when the buffer has sections (§8).

This is the authoritative structure in piece mode: Session::patterns still holds the union of every section’s lines, but only so a consumer can see which instruments the buffer needs — which line sounds when is the piece’s business, since the same name legitimately appears in every section.

Source

pub fn is_piece(&self) -> bool

Whether the buffer is a piece rather than a live session (§8.1).

Source

pub fn evaluate(&mut self, source: &str) -> EvalResult

Evaluate a source string, parse it, diff against previous state, and return the result.

Source

pub fn loads(&self) -> &[String]

load paths in the buffer, in the order they were written.

Source

pub fn definitions(&self) -> &HashMap<String, InstrumentDef>

Instruments defined in the buffer, by name.

Source

pub fn groups(&self) -> &HashMap<String, GroupDef>

Instrument groups in the buffer, by name.

Source

pub fn pending_deltas(&self) -> &[Delta]

Get the currently pending deltas.

Source

pub fn apply_pending(&mut self)

Apply pending deltas (called by the TUI at loop boundary).

Source

pub fn active_patterns(&self) -> Vec<&PatternDef>

Get the current active (non-muted) pattern definitions.

Source

pub fn all_patterns(&self) -> &HashMap<String, PatternDef>

Get all pattern definitions (including muted).

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Session

Source§

fn default() -> Self

Returns the “default value” for a 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.