Struct Format 

pub struct Format<D> { /* private fields */ }

How documents of type D are stored.

Implementations

impl<D: Serialize + DeserializeOwned> Format<D>

pub fn new(id: impl Into<String>, generator: impl Into<String>) -> Format<D>

Files tagged id (e.g. "acme.drawing"), written by generator (e.g. "Acme Draw 1.2.0").

pub fn migrations(self, m: Vec<Migration>) -> Self

The migration chain ([v1→v2, v2→v3, …]).

pub fn payload_key(self, key: impl Into<String>) -> Self

The envelope key holding the document (default "document").

pub fn legacy(self, probe: LegacyProbe) -> Self

Recognise bare pre-envelope documents.

pub fn oldest(self, v: u64) -> Self

Refuse files older than v (FormatError::TooOld).

pub fn pretty(self, on: bool) -> Self

Indented (diffable, the default) or compact (autosaves) output.

pub fn max_bytes(self, n: u64) -> Self

Refuse files larger than this.

pub fn extras_after_payload(self, on: bool) -> Self

Write extra envelope keys after the payload key instead of before it (default false). Reading accepts either order.

pub fn accept_untagged(self, on: bool) -> Self

Read envelopes that have no format tag (early files) when they have a schema_version and the payload key; such files are reported with this format’s id. Off by default: they are refused as FormatError::NotThisFormat. A format tag naming another format is always refused.

pub fn id(&self) -> &str

pub fn schema_version(&self) -> u64

The schema this build writes and the newest it reads.

pub fn encode(&self, doc: &D) -> Result<Vec<u8>, FormatError>

The file bytes for doc in the current schema.

pub fn encode_with( &self, doc: &D, extras: &Map<String, Value>, ) -> Result<Vec<u8>, FormatError>

Format::encode with extra envelope keys (envelope fields and the payload key win).

pub fn save(&self, path: &Path, doc: &D) -> Result<(), FormatError>

Encode and write doc to path durably.

pub fn load(&self, path: &Path) -> Result<Loaded<D>, FormatError>

Read a file from disk.

pub fn decode(&self, bytes: &[u8]) -> Result<Loaded<D>, FormatError>

Read file bytes (any supported schema).

Trait Implementations

impl<D> Debug for Format<D>

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

Formats the value using the given formatter.