Struct obsidian_export::Exporter [−][src]
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>
[src]
pub fn new(source: PathBuf, destination: PathBuf) -> Exporter<'a>
[src]
Create a new exporter which reads notes from source
and exports these to
destination
.
pub fn walk_options(&mut self, options: WalkOptions<'a>) -> &mut Exporter<'a>
[src]
Set the WalkOptions
to be used for this exporter.
pub fn frontmatter_strategy(
&mut self,
strategy: FrontmatterStrategy
) -> &mut Exporter<'a>
[src]
&mut self,
strategy: FrontmatterStrategy
) -> &mut Exporter<'a>
Set the FrontmatterStrategy
to be used for this exporter.
pub fn process_embeds_recursively(
&mut self,
recursive: bool
) -> &mut Exporter<'a>
[src]
&mut self,
recursive: bool
) -> &mut Exporter<'a>
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 run(&mut self) -> Result<(), ExportError>
[src]
Export notes using the settings configured on this exporter.
Trait Implementations
Auto Trait Implementations
impl<'a> !RefUnwindSafe for Exporter<'a>
[src]
impl<'a> Send for Exporter<'a>
[src]
impl<'a> Sync for Exporter<'a>
[src]
impl<'a> Unpin for Exporter<'a>
[src]
impl<'a> !UnwindSafe for Exporter<'a>
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,