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
impl PluginState
Sourcepub fn vendor(&self) -> &str
pub fn vendor(&self) -> &str
The vendor of the plugin that saved the state, or empty when it gave none.
Sourcepub fn version(&self) -> &str
pub fn version(&self) -> &str
The version of the plugin that saved the state, or empty when it gave none.
Sourcepub fn validate(&self) -> Result<(), InputError>
pub fn validate(&self) -> Result<(), InputError>
Checks the opaque payload before it is cloned or handed to a native plugin.
Sourcepub fn to_bytes(&self) -> Vec<u8> ⓘ
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.
Sourcepub fn from_bytes(bytes: &[u8]) -> Result<PluginState, InputError>
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.