Struct BusLayout 

#[non_exhaustive]
pub struct BusLayout {
    pub inputs: Vec<BusConfig>,
    pub outputs: Vec<BusConfig>,
}

Describes the audio bus configuration of a plugin.

By convention, the first input bus is the main audio in (effects + analyzers) and any subsequent input buses are sidechain inputs. The first output bus is the main audio out. Format wrappers (CLAP / VST3 / AU / AAX / LV2) rely on this ordering when they translate into format-specific main/aux bus designations, and BusConfig::kind lets call-sites that need it ask the bus directly rather than re-deriving the convention.

Construct via Self::new / Self::stereo + the with_* builders rather than struct literal - #[non_exhaustive] so pre-1.0 future fields don’t break downstream.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

inputs: Vec<BusConfig>

outputs: Vec<BusConfig>

Implementations

impl BusLayout

pub fn new() -> Self

pub fn stereo() -> Self

pub fn with_input(self, name: &'static str, channels: ChannelConfig) -> Self

Append a main audio input bus. First call → main audio in; subsequent calls → sidechain inputs (use Self::with_sidechain_input if you prefer to be explicit).

pub fn with_sidechain_input( self, name: &'static str, channels: ChannelConfig, ) -> Self

Append a sidechain input bus. Equivalent to Self::with_input after the first input has already been added, but lets call sites express intent.

pub fn with_output(self, name: &'static str, channels: ChannelConfig) -> Self

pub fn sidechain_input_indices(&self) -> impl Iterator<Item = usize> + '_

Return the indices of all sidechain input buses.

pub fn total_input_channels(&self) -> u32

pub fn total_output_channels(&self) -> u32

Trait Implementations

impl Clone for BusLayout

fn clone(&self) -> BusLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BusLayout

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

Formats the value using the given formatter.

impl Default for BusLayout

fn default() -> BusLayout

Returns the “default value” for a type.