Struct Document 

pub struct Document {
    pub source: String,
    pub path: Option<PathBuf>,
    pub title: Option<String>,
}

A Scrybe document — Markdown source with associated metadata.

Holds raw source text and a lazily-computed content identifier. Rendering happens in scrybe-render (P1.3).

Fields

source: String

The Markdown source text.

path: Option<PathBuf>

Optional on-disk path. None for untitled / in-memory documents.

title: Option<String>

Document title extracted from the first H1, if present.

Implementations

impl Document

pub fn new(source: impl Into<String>) -> Self

Creates a new in-memory document with the given source.

pub fn from_file(path: PathBuf, source: impl Into<String>) -> Self

Creates a document from a file path and its source.

The title is populated automatically from the first H1 heading.

pub fn len(&self) -> usize

Returns the byte length of the source.

pub fn is_empty(&self) -> bool

Returns true if the source is empty.

pub fn ast(&self) -> Ast

Parses the document source and returns its AST.

pub fn title_from_ast(&self) -> Option<String>

Returns the title extracted from the first H1 in the source, if any.

pub fn to_cbor(&self) -> Result<Vec<u8>, ScrybeError>

Serialises this document to deterministic CBOR bytes.

pub fn from_cbor(bytes: &[u8]) -> Result<Self, ScrybeError>

Deserialises a document from CBOR bytes.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContentAddressable for Document

fn content_id(&self) -> ContentId

Returns the content identifier for this value.

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.