Enum DocumentSpec 

#[repr(u8)]
pub enum DocumentSpec {
    Text(TextSpec),
    Structured(StructuredSpec),
    Markdown(MarkdownSpec),
}

A complete desired document or a source-preserving partial document.

Variants

Text(TextSpec)

A plain text document, rendered node by node.

Structured(StructuredSpec)

A structured (JSON, JSON5, TOML, or YAML) document.

Markdown(MarkdownSpec)

A Markdown document.

Implementations

impl DocumentSpec

pub fn set_string(format: Format, key: &ManagedPath, value: &str) -> Self

A structured document that sets the string at key to value and leaves the rest of the source alone. It keeps the line ending of the source.

fn payload(&self) -> &dyn Payload

pub const fn is_partial(&self) -> bool

Whether this document leaves any part of its source user-owned.

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

Check the document’s declaration without reading any source.

Errors

Returns an error for invalid ownership paths, for comment nodes that cannot be rendered and for invalid Markdown selectors.

pub fn reconcile( &self, current: Option<&[u8]>, ) -> Result<Vec<u8>, DocumentError>

Reconcile one desired document against its current source bytes.

Errors

Returns an error for invalid AST, unsupported partial ownership, malformed source, or a current source whose line endings cannot be resolved.

Trait Implementations

impl Clone for DocumentSpec

fn clone(&self) -> DocumentSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSpec

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

Formats the value using the given formatter.

impl<'ʄ> Facet<'ʄ> for DocumentSpec

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?