Struct VitalFormat 

pub struct VitalFormat { /* private fields */ }

The .vital format.

A read parses the whole JSON tree. Peak memory depends on the shape of the file: a file of long base64 texts takes about 3 times its size, and a file of short numbers up to about 38 times. Measured in a release build: 60 MB of 0, items peaked at 2.28 GB, 60 MB in one text at 184 MB.

Implementations

impl VitalFormat

pub const fn new(max_bytes: usize) -> Self

A format whose reader refuses inputs larger than max_bytes.

Trait Implementations

impl Debug for VitalFormat

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

Formats the value using the given formatter.

impl PresetFormat for VitalFormat

fn synth(&self) -> Synth

The synth the format serves.

fn extension(&self) -> &'static str

The file extension without the dot.

fn max_bytes(&self) -> usize

The largest input PresetFormat::read accepts, in bytes.

fn read(&self, bytes: &[u8]) -> Result<Box<dyn PresetModel>, FormatError>

Decodes a preset.

fn read_header(&self, bytes: &[u8]) -> Result<Header, FormatError>

Decodes only the header fields, without the large parts.

fn write(&self, model: &dyn PresetModel) -> Result<Vec<u8>, FormatError>

Encodes a model of this synth.

fn absent_means_default(&self, _key: &str) -> bool

Whether a missing key and an explicit default sound the same.

fn template(&self) -> &dyn TemplateSource

Where the template of this synth comes from.

fn route_sources(&self) -> &'static [&'static str]

The names a modulation source may take.

fn default_polarity(&self, source: &str) -> RoutePolarity

The polarity of a route whose edit names none.

fn check_value(&self, _key: &str, _stored: f64) -> Result<(), FormatError>

Checks a stored value that the registry range allows but the writer cannot write yet.

fn scan( &self, model: &dyn PresetModel, edited: &[&str], ) -> Result<Vec<String>, FormatError>

Scans a model after an edit list: every control holds a value of the right wire type inside its range, and the structured parts are whole. Returns warnings, such as a route into a switched-off module.

fn factory_folder(&self) -> &'static [&'static str]

The trailing folder names of the synth’s factory preset folder, outermost first, such as the data folder and then Factory. The writer refuses to write into it. Empty when the synth has none.