Skip to main content

Arranger

Struct Arranger 

Source
pub struct Arranger {
    pub placements: Vec<ArrangerPlacement>,
    pub lanes: Vec<LaneId>,
}
Expand description

Arrangement of playable material laid out across lanes on a timeline.

Holds the ordered set of ArrangerPlacements plus the lane ids the arrangement declares, and renders them into play events.

Fields§

§placements: Vec<ArrangerPlacement>

Placements that make up the arrangement, in declaration order.

§lanes: Vec<LaneId>

Lane ids the arrangement declares.

Implementations§

Source§

impl Arranger

Source

pub fn new( placements: Vec<ArrangerPlacement>, lanes: Vec<LaneId>, ) -> Result<Self>

Builds an arranger from placements and lane ids, validating each placement.

Source§

impl Arranger

Source

pub fn to_expr(&self) -> Expr

Encodes the arrangement as a tagged music/arranger expression map.

Source

pub fn from_expr(expr: &Expr) -> Result<Self>

Decodes an arrangement from a tagged music/arranger expression map.

Source§

impl Arranger

Source

pub fn render_arrangement(&self, cx: &PlayContext) -> Result<ArrangerRender>

Renders the arrangement into clipped, stable-ordered play events.

Applies each placement’s stretch, transforms, pitch remap, and filter, clips events to the context range, and appends diagnostics and traces.

Source

pub fn rendered_notes(&self) -> Vec<TimedNote>

Renders the arrangement and returns only its timed notes.

Source

pub fn diagnostics(&self) -> Vec<ArrangerDiagnostic>

Renders the arrangement and returns only the diagnostics it raises.

Trait Implementations§

Source§

impl Clone for Arranger

Source§

fn clone(&self) -> Arranger

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 Debug for Arranger

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Arranger

Source§

impl MusicObject for Arranger

Source§

fn kind(&self) -> &'static str

Returns a stable, human-readable tag for this object kind.
Source§

fn duration(&self) -> Time

Returns the total duration this object occupies.
Source§

fn voices<'a>(&'a self, offset: Time, out: &mut Vec<TimedAtom<'a>>)

Appends the timed atoms produced by this object, shifted by offset.
Source§

fn clone_box(&self) -> Box<dyn MusicObject>

Clones this object into a fresh boxed trait object.
Source§

fn as_any(&self) -> &dyn Any

Returns this object as a &dyn Any for downcasting.
Source§

impl PartialEq for Arranger

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.