Struct Exporter

pub struct Exporter<'a> { /* private fields */ }

Exporter provides the main interface to this library.

Users are expected to create an Exporter using Exporter::new, optionally followed by customization using Exporter::frontmatter_strategy and Exporter::walk_options.

After that, calling Exporter::run will start the export process.

Implementations

impl<'a> Exporter<'a>

pub fn new(root: PathBuf, destination: PathBuf) -> Self

Create a new exporter which reads notes from root and exports these to destination.

pub fn start_at(&mut self, start_at: PathBuf) -> &mut Self

Set a custom starting point for the export.

Normally all notes under root (except for notes excluded by ignore rules) will be exported. When start_at is set, only notes under this path will be exported to the target destination.

pub fn walk_options(&mut self, options: WalkOptions<'a>) -> &mut Self

Set the WalkOptions to be used for this exporter.

pub fn frontmatter_strategy( &mut self, strategy: FrontmatterStrategy, ) -> &mut Self

Set the FrontmatterStrategy to be used for this exporter.

pub fn process_embeds_recursively(&mut self, recursive: bool) -> &mut Self

Set the behavior when recursive embeds are encountered.

When recursive is true (the default), emdeds are always processed recursively. This may lead to infinite recursion when note A embeds B, but B also embeds A. (When this happens, ExportError::RecursionLimitExceeded will be returned by Exporter::run).

When recursive is false, if a note is encountered for a second time while processing the original note, instead of embedding it again a link to the note is inserted instead.

pub fn preserve_mtime(&mut self, preserve: bool) -> &mut Self

Set whether the modified time of exported files should be preserved.

When preserve is true, the modified time of exported files will be set to the modified time of the source file.

pub fn add_postprocessor( &mut self, processor: &'a Postprocessor<'_>, ) -> &mut Self

Append a function to the chain of postprocessors to run on exported Obsidian Markdown notes.

pub fn add_embed_postprocessor( &mut self, processor: &'a Postprocessor<'_>, ) -> &mut Self

Append a function to the chain of postprocessors for embeds.

pub fn run(&mut self) -> Result<(), ExportError>

Export notes using the settings configured on this exporter.

Trait Implementations

impl<'a> Clone for Exporter<'a>

fn clone(&self) -> Exporter<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Exporter<'a>

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

Formats the value using the given formatter.