Skip to main content

FsLoader

Struct FsLoader 

Source
pub struct FsLoader;
Expand description

Reads files from the filesystem with std::fs. Its current directory is the process’s working directory: without a base directory, relative paths in a document given as bytes resolve against it, while those in a file given to super::Parser::parse_file resolve against that file’s directory.

Implementations§

Source§

impl FsLoader

Source

pub fn new() -> Self

The filesystem loader.

Trait Implementations§

Source§

impl Clone for FsLoader

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FsLoader

Source§

impl Debug for FsLoader

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FsLoader

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for FsLoader

Source§

impl Loader for FsLoader

Available on crate feature fs only.
Source§

fn current_dir(&self) -> Result<PathBuf>

The directory that relative paths in a document given as bytes, and a relative path given to super::Parser::parse_file, resolve against when the parser has no base directory of its own. It is then also CURDIR for a document given as bytes (spec §7.8) and for macro argument lists in it (spec §9.2).
Source§

fn canonicalize(&self, path: &Path) -> Result<PathBuf>

path made canonical: absolute, with . and .. components and symbolic links resolved (spec §9.3). An error when nothing exists at path.
Source§

fn canonicalize_optional(&self, path: &Path) -> Result<PathBuf>

Canonicalize an optional include path. Loaders may reject a missing path early; the default keeps the behavior of existing loader implementations.
Source§

fn kind(&self, path: &Path) -> Option<FileKind>

What path names, following symbolic links, or None if nothing exists there.
Source§

fn read(&self, path: &Path) -> Result<Vec<u8>>

The contents of the regular file at path.
Source§

fn read_limited(&self, path: &Path, limit: u64) -> Result<Vec<u8>>

The contents of the regular file at path if it holds at most limit bytes; if it holds more, any part of it longer than limit bytes, such as its first limit + 1 bytes. A parser with an input limit (super::Parser::set_max_input_bytes) reads files with it, so that a large file is not read whole only to be rejected. Read more
Source§

fn read_dir(&self, path: &Path) -> Result<Vec<String>>

The names of the entries of the directory at path, in any order, without . and ... Names that are not valid UTF-8 may be left out. Used to expand glob patterns (spec §9.4).
Source§

impl PartialEq for FsLoader

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FsLoader

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.