Skip to main content

InputError

Enum InputError 

Source
#[non_exhaustive]
pub enum InputError {
Show 41 variants AudioSlotCount, AudioBusCount, AudioChannelCount, DuplicateAudioBus { id: u64, }, AudioBusLayout { id: u64, }, AudioRoute { slot: usize, bus: u64, }, ChannelAdaptation { source: Layout, target: Layout, }, AudioBuffers, AudioSampleFormat, StateSize, StateBytes, ParameterChoicePage, PresetSize, Transport, Automation, NotAutomatable { id: u64, }, HostIdentity, PresetDiscoveryTarget, EmptyChain, SampleRate, BlockSize, OutputCount, MainBus, Slot, ParameterValue, ParameterText, PlainParameterValue, UnknownParameter { id: u64, }, ReadOnlyParameter { id: u64, }, EventCapacity, EventPortCount, DuplicateEventPort { id: u64, }, EventRoute { slot: usize, port: u64, }, EventPort { port: usize, }, Events, PathEncoding, RealtimeQuantum, RealtimeLatency, RealtimeDry, RemoteRegion, RemoteEditor,
}
Expand description

A request rejected before changing the plugin or its processing configuration.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

AudioSlotCount

Routing entries do not match the number of loaded plugin slots.

§

AudioBusCount

A direction exceeds MAX_AUDIO_BUSES.

§

AudioChannelCount

A direction exceeds MAX_AUDIO_CHANNELS active channels.

§

DuplicateAudioBus

A native bus ID occurs more than once in one direction.

Fields

§id: u64

Native ID associated with the invalid request.

§

AudioBusLayout

An active bus requested the empty layout.

Fields

§id: u64

Native ID associated with the invalid request.

§

AudioRoute

An active input bus names a missing or inactive source.

Fields

§slot: usize

Zero-based destination plugin slot.

§bus: u64

Native destination input bus ID.

§

ChannelAdaptation

The requested conversion does not match the two layouts.

Fields

§source: Layout

Layout supplied by the source.

§target: Layout

Layout requested by the destination.

§

AudioBuffers

Channel counts or per-channel frame lengths do not match the prepared buses, or a block has more frames than the prepared maximum block size.

§

AudioSampleFormat

Sample precision differs from the prepared configuration.

§

StateSize

Aggregate component and controller state exceeds MAX_STATE_BYTES.

§

StateBytes

Bytes given to PluginState::from_bytes are not a state that plughost wrote, or are one of a later format version.

§

ParameterChoicePage

A discrete-choice page has an invalid start index or count.

§

PresetSize

Native preset bytes exceed MAX_PRESET_BYTES.

§

Transport

Transport contains a non-finite, unrepresentable, or inconsistent value.

§

Automation

Automation is unordered, out of range, outside the block, or names a missing slot.

§

NotAutomatable

The addressed parameter does not support sample-timed automation.

Fields

§id: u64

Native ID associated with the invalid request.

§

HostIdentity

Host text contains NUL, or its name is empty or exceeds 127 UTF-16 code units.

§

PresetDiscoveryTarget

A preset discovery provider ID is empty, contains NUL or exceeds PRESET_DISCOVERY_TEXT_BYTES, or its file location is not an absolute Unicode path within that size and without NUL.

§

EmptyChain

A chain was created or configured without a plugin.

§

SampleRate

The sample rate is not finite and greater than zero.

§

BlockSize

Maximum block size is outside 1..=i32::MAX.

§

OutputCount

The legacy configuration does not provide one output layout per plugin.

§

MainBus

The plugin has no main audio bus with the requested layout.

§

Slot

The slot index does not address a loaded plugin.

§

ParameterValue

The parameter value is not finite and normalized to 0..=1.

§

ParameterText

Display text is excessive, contains NUL, or is rejected by the plugin.

§

PlainParameterValue

The native-unit parameter value is non-finite or outside the native range.

§

UnknownParameter

The requested parameter ID does not exist.

Fields

§id: u64

Native ID associated with the invalid request.

§

ReadOnlyParameter

A host edit addressed a read-only parameter.

Fields

§id: u64

Native ID associated with the invalid request.

§

EventCapacity

Combined automation/events or SysEx bytes exceed the per-block capacity.

§

EventPortCount

An event routing direction exceeds MAX_EVENT_PORTS.

§

DuplicateEventPort

An output port ID occurs more than once in a slot.

Fields

§id: u64

Native ID associated with the invalid request.

§

EventRoute

An event input route names an unavailable source.

Fields

§slot: usize

Zero-based destination plugin slot.

§port: u64

Native destination event input port ID.

§

EventPort

An event names an external port the chain does not expose.

Fields

§port: usize

Invalid zero-based external event port index.

§

Events

Events that are not valid, in offset order, or inside the block, or for a render before the end of its input.

§

PathEncoding

A bundle or preset path cannot be represented by the helper’s Unicode path protocol.

§

RealtimeQuantum

A realtime quantum is zero frames or exceeds the prepared maximum block size.

§

RealtimeLatency

A realtime latency is not one, two or three quanta.

§

RealtimeDry

A dry fallback needs as many output channels as input channels.

§

RemoteRegion

No remote editor region was set, or the one given does not have a finite position and a positive size within an existing display.

§

RemoteEditor

The slot has no open remote editor.

Trait Implementations§

Source§

impl Clone for InputError

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 Copy for InputError

Source§

impl Debug for InputError

Source§

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

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

impl Display for InputError

Source§

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

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

impl Eq for InputError

Source§

impl Error for InputError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl PartialEq for InputError

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
Source§

impl StructuralPartialEq for InputError

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.