Skip to main content

PluginState

Struct PluginState 

Source
pub struct PluginState { /* private fields */ }
Expand description

A plugin’s saved state with the identity of the class it belongs to. Its contents are opaque: store it with PluginState::to_bytes and read it back with PluginState::from_bytes, which later plughost versions keep reading. Where it is stored is up to the application.

The name, vendor and version are those of the plugin that saved it, for display: a restore checks only the PluginId, so a state saved by another version of the plugin restores, and the plugin decides what to make of it.

Implementations§

Source§

impl PluginState

Source

pub fn id(&self) -> &PluginId

The plugin class that may restore this state.

Source

pub fn name(&self) -> &str

The display name of the plugin that saved the state.

Source

pub fn vendor(&self) -> &str

The vendor of the plugin that saved the state, or empty when it gave none.

Source

pub fn version(&self) -> &str

The version of the plugin that saved the state, or empty when it gave none.

Source

pub fn validate(&self) -> Result<(), InputError>

Checks the opaque payload before it is cloned or handed to a native plugin.

Source

pub fn to_bytes(&self) -> Vec<u8> ⓘ

The state in plughost’s persisted form: a versioned container of tagged sections for the identity and each native payload, independent of the helper protocol. Store these bytes; PluginState::from_bytes reads them in this and later plughost versions.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<PluginState, InputError>

Reads bytes PluginState::to_bytes wrote, in this or an earlier plughost version from 0.2.0 on, without a plugin, so a state of a plugin that is not installed can be kept and written again unchanged. Bytes that are not such a state fail with crate::InputError::StateBytes, and a payload over MAX_STATE_BYTES with crate::InputError::StateSize, before anything of that size is allocated.

Trait Implementations§

Source§

impl Clone for PluginState

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 Debug for PluginState

Source§

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

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

impl Eq for PluginState

Source§

impl PartialEq for PluginState

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 PluginState

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