Struct Format 

pub struct Format {
    pub name: String,
    pub read: Arc<ReadFn>,
    pub write: Arc<WriteFn>,
    pub check: Option<Arc<CheckFn>>,
}

A registered format: a name plus read/write callables and an optional check. Mirrors Python’s Format NamedTuple (name, read, write, check); a plugin registered with Format::new alone has no check, and crate::document::Doc::check_format errors cleanly (not a panic) if invoked on it – matching test_plugin_without_check_raises_on_check_format.

Fields

name: String

Registered format name (e.g. "json").

read: Arc<ReadFn>

Text to Doc reader callable.

write: Arc<WriteFn>

Doc to text writer callable.

check: Option<Arc<CheckFn>>

Optional Doc write simulation callable.

Implementations

impl Format

pub fn new( name: impl Into<String>, read: impl Fn(&str) -> Result<Doc, OmnistError> + Send + Sync + 'static, write: impl Fn(&Doc) -> Result<String, OmnistError> + Send + Sync + 'static, ) -> Self

Build a Format with no check callable. Use Format::with_check to attach one.

pub fn with_check( self, check: impl Fn(&Doc) -> WriteReport + Send + Sync + 'static, ) -> Self

Attach a check callable, returning self for chaining.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.