Struct mdbook_files::Files

pub struct Files {

    pub path: Utf8PathBuf,
    pub files: Vec<String>,
    pub default_file: Option<Utf8PathBuf>,
    pub ignore_case_insensitive: bool,
    pub same_file_system: bool,
    pub types: Vec<String>,
    pub hidden: bool,
    pub follow_links: bool,
    pub dot_ignore: bool,
    pub git_global: bool,
    pub git_exclude: bool,
    pub git_ignore: bool,
    pub require_git: bool,
    pub git_ignore_parents: bool,
    pub max_depth: Option<usize>,
    pub max_filesize: Option<u64>,
    pub height: Option<String>,
}

Configuration for an invocation of files

Fields

path: Utf8PathBuf

Path to files

files: Vec<String>

Add a glob to the set of overrides.

Globs provided here have precisely the same semantics as a single line in a gitignore file, where the meaning of ! is inverted: namely, ! at the beginning of a glob will ignore a file. Without !, all matches of the glob provided are treated as whitelist matches.

default_file: Option<Utf8PathBuf>

When specified, path to the file that is opened by default.

ignore_case_insensitive: bool

Process ignores case insensitively

same_file_system: bool

Do not cross file system boundaries.

When this option is enabled, directory traversal will not descend into directories that are on a different file system from the root path.

types: Vec<String>

Select the file type given by name.

hidden: bool

Enables ignoring hidden files.

follow_links: bool

Whether to follow symbolic links or not.

dot_ignore: bool

Enables reading .ignore files.

.ignore files have the same semantics as gitignore files and are supported by search tools such as ripgrep and The Silver Searcher.

git_global: bool

Enables reading a global gitignore file, whose path is specified in git’s core.excludesFile config option.

git_exclude: bool

Enables reading .git/info/exclude files.

git_ignore: bool

Enables reading .gitignore files.

require_git: bool

Whether a git repository is required to apply git-related ignore rules (global rules, .gitignore and local exclude rules).

git_ignore_parents: bool

Enables reading ignore files from parent directories.

max_depth: Option<usize>

The maximum depth to recurse.

max_filesize: Option<u64>

Whether to ignore files above the specified limit.

height: Option<String>

Trait Implementations

impl Debug for Files

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Files

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.