Struct ignore_files::IgnoreFilesFromOriginArgs

#[non_exhaustive]
pub struct IgnoreFilesFromOriginArgs {
    pub origin: PathBuf,
    pub explicit_watches: Vec<PathBuf>,
    pub explicit_ignores: Vec<PathBuf>,
}

Arguments for finding ignored files in a given directory and subdirectories

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: PathBuf

Origin from which finding ignored files will start.

explicit_watches: Vec<PathBuf>

Paths that have been explicitly selected to be watched.

If this list is non-empty, all paths not on this list will be ignored.

These paths must be absolute and normalised (no . and .. components).

explicit_ignores: Vec<PathBuf>

Paths that have been explicitly ignored.

If this list is non-empty, all paths on this list will be ignored.

These paths must be absolute and normalised (no . and .. components).

Implementations

impl IgnoreFilesFromOriginArgs

pub fn check(&self) -> Result<()>

Check that this struct is correctly-formed.

pub async fn canonicalise(self) -> Result<Self>

Canonicalise all paths.

The result is always well-formed.

pub fn new( origin: impl AsRef<Path>, explicit_watches: Vec<PathBuf>, explicit_ignores: Vec<PathBuf> ) -> Result<Self>

Create args with all fields set and check that they are correctly-formed.

pub fn new_unchecked( origin: impl AsRef<Path>, explicit_watches: impl IntoIterator<Item = impl Into<PathBuf>>, explicit_ignores: impl IntoIterator<Item = impl Into<PathBuf>> ) -> Self

Create args without checking well-formed-ness.

Use this only if you know that the args are well-formed, or if you are about to call canonicalise() on them.

Trait Implementations

impl Clone for IgnoreFilesFromOriginArgs

fn clone(&self) -> IgnoreFilesFromOriginArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IgnoreFilesFromOriginArgs

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

Formats the value using the given formatter.

impl Default for IgnoreFilesFromOriginArgs

fn default() -> IgnoreFilesFromOriginArgs

Returns the “default value” for a type.

impl From<&Path> for IgnoreFilesFromOriginArgs

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl PartialEq for IgnoreFilesFromOriginArgs

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for IgnoreFilesFromOriginArgs

impl StructuralEq for IgnoreFilesFromOriginArgs

impl StructuralPartialEq for IgnoreFilesFromOriginArgs