Enum Message 

pub enum Message {
    Sandboxed {
        mechanism: String,
    },
    Hello {
        magic: [u8; 4],
        major: u16,
        minor: u16,
    },
    Load {
        path: String,
        format: PluginFormat,
        class_id: Option<[u8; 16]>,
    },
    Configure {
        rate: u32,
        max_frames: u32,
        in_channels: u16,
        out_channels: u16,
    },
    Editor(EditorAction),
    EditorStatus(EditorStatus),
    EditorImage(EditorImage),
    Prepare(ProcessingSetup),
    Describe,
    Features(Capabilities),
    Activate,
    SetState {
        blob: Vec<u8>,
    },
    GetState,
    OpenEditor,
    OpenEditorIn {
        parent: ParentWindow,
    },
    CloseEditor,
    ListParameters {
        start: u32,
        count: u16,
    },
    Parameters {
        total: u32,
        entries: Vec<Parameter>,
    },
    SetParameter {
        id: u32,
        value: f64,
    },
    RequestError {
        code: u32,
        text: String,
    },
    Shutdown,
    Scan {
        path: String,
    },
    Loaded {
        name: String,
        vendor: String,
        latency_frames: u32,
        inputs: Vec<BusInfo>,
        outputs: Vec<BusInfo>,
    },
    Classes {
        entries: Vec<ClassInfo>,
    },
    LatencyChanged {
        frames: u32,
    },
    State {
        blob: Vec<u8>,
    },
    ParamsChanged,
    Fault {
        code: u32,
        text: String,
    },
    Ack,
    EditorClosed,
    EditorResized {
        width: u32,
        height: u32,
    },
    ParameterEdit {
        id: u32,
        phase: EditPhase,
        value: f64,
    },
}

Variants

Sandboxed

Sent before Hello only when an OS sandbox was requested and installed.

Fields

mechanism: String

Hello

Fields

magic: [u8; 4]

major: u16

minor: u16

Load

Fields

path: String

format: PluginFormat

class_id: Option<[u8; 16]>

Configure

Fields

rate: u32

max_frames: u32

in_channels: u16

out_channels: u16

Editor(EditorAction)

EditorStatus(EditorStatus)

EditorImage(EditorImage)

Prepare(ProcessingSetup)

Describe

Features(Capabilities)

Activate

SetState

Fields

blob: Vec<u8>

GetState

OpenEditor

OpenEditorIn

Fields

parent: ParentWindow

CloseEditor

ListParameters

Fields

start: u32

count: u16

Parameters

Fields

total: u32

entries: Vec<Parameter>

SetParameter

Fields

id: u32

value: f64

RequestError

Fields

code: u32

text: String

Shutdown

Scan

Fields

path: String

Loaded

Fields

name: String

vendor: String

latency_frames: u32

inputs: Vec<BusInfo>

outputs: Vec<BusInfo>

Classes

Fields

entries: Vec<ClassInfo>

LatencyChanged

Fields

frames: u32

State

Fields

blob: Vec<u8>

ParamsChanged

Fault

Fields

code: u32

text: String

Ack

The reply to a request that returns no data (Configure, Activate, SetState, OpenEditor). It carries the request’s number.

EditorClosed

The editor window was closed by the user.

EditorResized

Fields

width: u32

height: u32

ParameterEdit

Fields

id: u32

phase: EditPhase

value: f64

Implementations

impl Message

pub fn hello() -> Self

pub fn kind(&self) -> u16

The wire kind number, for diagnostics.

Trait Implementations

impl Clone for Message

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 Message

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

Formats the value using the given formatter.

impl PartialEq for Message

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Message