Skip to main content

FormatFileError

Enum FormatFileError 

Source
pub enum FormatFileError {
    Io(Error),
    Format {
        source: String,
        error: FormatSourceError,
    },
}
Expand description

Describes an I/O failure or retains the source and diagnostic for refused formatting.

format_file stores the original source in Self::Format without changing the file.

§Examples

use adam_fmt::{FormatFileError, render_error};
use std::{io, path::Path};

let error = FormatFileError::Io(io::Error::other("unavailable"));
assert_eq!(
    render_error(Path::new("sheet.adm2"), &error),
    "adam-fmt: sheet.adm2: unavailable\n"
);

Variants§

§

Io(Error)

path could not be read, or (only after formatting succeeds and differs) written back.

§

Format

path’s contents could not be safely formatted.

Fields

§source: String

path’s original contents, needed by render_error to render a source-anchored diagnostic.

§error: FormatSourceError

Why formatting was refused.

Trait Implementations§

Source§

impl Debug for FormatFileError

Source§

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

Formats the value using the given formatter. Read more

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> 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.