Struct MusicComponentDescriptor 

pub struct MusicComponentDescriptor {

    pub id: Symbol,
    pub label: String,
    pub category: MusicComponentCategory,
    pub capabilities: BTreeSet<MusicCapability>,
    pub ports: Vec<MusicPortDescriptor>,
    pub lanes: Vec<LaneDescriptor>,
    pub params: Vec<MusicParamDescriptor>,
    pub rate: RateContract,
    pub determinism: DeterminismPolicy,
    pub accepted_event_families: Vec<LaneKind>,
    pub output_families: Vec<LaneKind>,
    pub latency: Symbol,
    pub implemented: bool,
}

Full description of a music component: its identity, category, capabilities, ports, lanes, parameters, and behavioral contracts.

Built fluently via MusicComponentDescriptor::new and the with_* methods, then rendered for transport with MusicComponentDescriptor::to_expr.

Fields

id: Symbol

Stable identifier for the component.

label: String

Human-readable label.

category: MusicComponentCategory

The category the component belongs to.

capabilities: BTreeSet<MusicCapability>

Capabilities the component advertises.

ports: Vec<MusicPortDescriptor>

Input and output ports, ordered by id.

lanes: Vec<LaneDescriptor>

Lane descriptors produced by the component, in stable order.

params: Vec<MusicParamDescriptor>

Configurable parameters, ordered by id.

rate: RateContract

The rate contract the component runs at.

determinism: DeterminismPolicy

How reproducible the component’s output is.

accepted_event_families: Vec<LaneKind>

Lane kinds the component accepts as input.

output_families: Vec<LaneKind>

Lane kinds the component emits as output.

latency: Symbol

The latency class symbol derived from the rate contract.

implemented: bool

Whether the component has a working implementation.

Implementations

impl MusicComponentDescriptor

pub fn new( id: Symbol, label: impl Into<String>, category: MusicComponentCategory, rate: RateContract, ) -> Self

Creates a descriptor with default capabilities, ports, lanes, and params.

The latency symbol is derived from rate and implemented defaults to true.

pub fn with_capability(self, capability: MusicCapability) -> Self

Adds a capability and returns the updated descriptor.

pub fn with_port(self, port: MusicPortDescriptor) -> Self

Adds a port and re-sorts the port list by id.

pub fn with_lane(self, lane: LaneDescriptor) -> Self

Adds a lane and restores the stable lane order.

pub fn with_param(self, param: MusicParamDescriptor) -> Self

Adds a parameter and re-sorts the parameter list by id.

pub fn with_events(self, accepted: Vec<LaneKind>, output: Vec<LaneKind>) -> Self

Sets the accepted and output lane kinds, sorting and deduplicating each.

pub fn with_determinism(self, determinism: DeterminismPolicy) -> Self

Sets the determinism policy and returns the updated descriptor.

pub fn with_implemented(self, implemented: bool) -> Self

Sets the implemented flag and returns the updated descriptor.

pub fn has_capability(&self, capability: MusicCapability) -> bool

Returns true if the descriptor advertises capability.

pub fn to_expr(&self) -> Expr

Renders the full descriptor as an Expr map for wire transport.

Trait Implementations

impl Clone for MusicComponentDescriptor

fn clone(&self) -> MusicComponentDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MusicComponentDescriptor

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

Formats the value using the given formatter.

impl Eq for MusicComponentDescriptor

impl PartialEq for MusicComponentDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MusicComponentDescriptor