Skip to main content

ForeignState

Enum ForeignState 

Source
pub enum ForeignState<'a> {
    Raw {
        format: PluginFormat,
        source_key: Option<&'a str>,
        bytes: &'a [u8],
    },
    MismatchedEnvelope {
        plugin_id_hash: u64,
        params: &'a [(u32, f64)],
        extra: Option<&'a [u8]>,
    },
}
Expand description

What a format wrapper found where truce state should have been. Handed to crate::plugin::PluginRuntime::migrate_state on the host thread; the plugin decides whether it recognizes the bytes.

Variants§

§

Raw

Bytes that aren’t a truce envelope: a previous framework’s state, exactly as the old build saved it.

Fields

§source_key: Option<&'a str>

The container key the bytes were found under, for keyed formats (AU dict key, LV2 property URI, AAX chunk id). None for stream formats (CLAP / VST3 / VST2).

§bytes: &'a [u8]
§

MismatchedEnvelope

A valid truce envelope whose plugin_id_hash doesn’t match: the plugin was renamed / re-identified. Params are already decoded; the plugin only decides whether to accept them.

Fields

§plugin_id_hash: u64
§params: &'a [(u32, f64)]
§extra: Option<&'a [u8]>

Auto Trait Implementations§

§

impl<'a> Freeze for ForeignState<'a>

§

impl<'a> RefUnwindSafe for ForeignState<'a>

§

impl<'a> Send for ForeignState<'a>

§

impl<'a> Sync for ForeignState<'a>

§

impl<'a> Unpin for ForeignState<'a>

§

impl<'a> UnsafeUnpin for ForeignState<'a>

§

impl<'a> UnwindSafe for ForeignState<'a>

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> 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, 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.