Enum ignore::Error

source · [−]

pub enum Error {
    Partial(Vec<Error>),
    WithLineNumber {
        line: u64,
        err: Box<Error>,
    },
    WithPath {
        path: PathBuf,
        err: Box<Error>,
    },
    WithDepth {
        depth: usize,
        err: Box<Error>,
    },
    Loop {
        ancestor: PathBuf,
        child: PathBuf,
    },
    Io(Error),
    Glob {
        glob: Option<String>,
        err: String,
    },
    UnrecognizedFileType(String),
    InvalidDefinition,
}

Expand description

Represents an error that can occur when parsing a gitignore file.

Variants

`Partial(Vec<Error>)`

A collection of “soft” errors. These occur when adding an ignore file partially succeeded.

`WithLineNumber`

Fields

line: u64

The line number.

err: Box<Error>

The underlying error.

An error associated with a specific line number.

`WithPath`

Fields

path: PathBuf

The file path.

err: Box<Error>

The underlying error.

An error associated with a particular file path.

`WithDepth`

Fields

depth: usize

The directory depth.

err: Box<Error>

The underlying error.

An error associated with a particular directory depth when recursively walking a directory.

`Loop`

Fields

ancestor: PathBuf

The ancestor file path in the loop.

child: PathBuf

The child file path in the loop.

An error that occurs when a file loop is detected when traversing symbolic links.

`Io(Error)`

An error that occurs when doing I/O, such as reading an ignore file.

`Glob`

Fields

glob: Option<String>

The original glob that caused this error. This glob, when available, always corresponds to the glob provided by an end user. e.g., It is the glob as written in a .gitignore file.

(This glob may be distinct from the glob that is actually compiled, after accounting for gitignore semantics.)

err: String

The underlying glob error as a string.

An error that occurs when trying to parse a glob.

`UnrecognizedFileType(String)`

A type selection for a file type that is not defined.

`InvalidDefinition`

A user specified file type definition could not be parsed.

Implementations

source

impl Error

source

pub fn is_partial(&self) -> bool

Returns true if this is a partial error.

A partial error occurs when only some operations failed while others may have succeeded. For example, an ignore file may contain an invalid glob among otherwise valid globs.

source

pub fn is_io(&self) -> bool

Returns true if this error is exclusively an I/O error.

source

pub fn io_error(&self) -> Option<&Error>

Inspect the original io::Error if there is one.

None is returned if the Error doesn’t correspond to an io::Error. This might happen, for example, when the error was produced because a cycle was found in the directory tree while following symbolic links.

This method returns a borrowed value that is bound to the lifetime of the Error. To obtain an owned value, the into_io_error can be used instead.