Enum `Error`

pub enum Error

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 { line: u64, err: Box<Error> }: An error associated with a specific line number.
WithPath { path: PathBuf, err: Box<Error> }: An error associated with a particular file path.
WithDepth { depth: usize, err: Box<Error> }: An error associated with a particular directory depth when recursively walking a directory.
Loop { ancestor: PathBuf, child: PathBuf }: 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 { glob: Option<String>, err: 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

`impl Error`

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.

fn is_io(&self) -> bool

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

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

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

None is returned if the Error doesn't correspond to an std::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.

This is the original std::io::Error and is not the same as impl From<Error> for std::io::Error which contains additional context about the error.

fn into_io_error(self) -> Option<Error>

Similar to io_error except consumes self to convert to the original std::io::Error if one exists.

fn depth(&self) -> Option<usize>

Returns a depth associated with recursively walking a directory (if this error was generated from a recursive directory iterator).

Trait Implementations

`impl Clone for Error`

fn clone(&self) -> Error

`impl Debug for Error`

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

`impl Display for Error`

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

`impl Error for Error`

fn description(&self) -> &str

`impl From<Error> for Error`

fn from(err: Error) -> Error

Auto Trait Implementations

`impl !RefUnwindSafe for Error`

`impl !UnwindSafe for Error`

`impl Freeze for Error`

`impl Send for Error`

`impl Sync for Error`

`impl Unpin for Error`

`impl UnsafeUnpin for Error`

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

`impl<T> From<T> for Error`

fn from(t: T) -> T: Returns the argument unchanged.

`impl<T> Pointable for Error`

const ALIGN: usize = _;
type Init = T;
unsafe fn init(init: <T as Pointable>::Init) -> usize
unsafe fn deref<'a>(ptr: usize) -> &'a T
unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
unsafe fn drop(ptr: usize)

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

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

`impl<T> ToString for Error where T: Display + ?Sized,`

fn to_string(&self) -> String

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = never;
fn try_from(value: U) -> Result<T, never>

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

type Error = >::Error;
fn try_into(self) -> Result<U, >::Error>