Struct obsidian_export::WalkOptions

pub struct WalkOptions<'a> {
    pub ignore_filename: &'a str,
    pub ignore_hidden: bool,
    pub honor_gitignore: bool,
    pub filter_fn: Option<&'static (dyn Fn(&DirEntry) -> bool + Send + Sync + 'static)>,
}

WalkOptions specifies how an Obsidian vault directory is scanned for eligible files to export.

Fields

ignore_filename: &'a str

The filename for ignore files, following the gitignore syntax.

By default .export-ignore is used.

ignore_hidden: bool

Whether to ignore hidden files.

This is enabled by default.

honor_gitignore: bool

Whether to honor git’s ignore rules (.gitignore files, .git/config/exclude, etc) if the target is within a git repository.

This is enabled by default.

filter_fn: Option<&'static (dyn Fn(&DirEntry) -> bool + Send + Sync + 'static)>

An optional custom filter function which is called for each directory entry to determine if it should be included or not.

This is passed to ignore::WalkBuilder::filter_entry.

Implementations

impl<'a> WalkOptions<'a>

pub fn new() -> WalkOptions<'a>

Create a new set of options using default values.

Trait Implementations

impl<'a> Clone for WalkOptions<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WalkOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Default for WalkOptions<'a>

fn default() -> Self

Returns the “default value” for a type.