Enum ReadError 

pub enum ReadError {
    RepositoryRoot {
        source: Error,
    },
    ResolvePath {
        path: String,
        source: Error,
    },
    OutsideRepository {
        path: String,
    },
    Open {
        path: String,
        source: Error,
    },
    Read {
        path: String,
        source: Error,
    },
    OffsetBeyondEnd {
        offset: u64,
        path: String,
    },
    LineTooLong {
        line: u64,
        path: String,
    },
    InvalidUtf8 {
        line: u64,
        path: String,
    },
    ScanLimitExceeded {
        limit: usize,
        path: String,
    },
    Encode(Error),
}

Failure while safely executing one repository-relative read.

Variants

RepositoryRoot

The repository root could not be resolved.

Fields

source: Error

Underlying filesystem failure.

ResolvePath

The requested path could not be resolved.

Fields

path: String

Repository-relative requested path.

source: Error

Underlying filesystem failure.

OutsideRepository

The canonical requested path escapes the canonical repository root.

Fields

path: String

Repository-relative requested path.

Open

The requested file could not be opened.

Fields

path: String

Repository-relative requested path.

source: Error

Underlying filesystem failure.

Read

The requested file could not be read.

Fields

path: String

Repository-relative requested path.

source: Error

Underlying filesystem failure.

OffsetBeyondEnd

The requested line does not exist.

Fields

offset: u64

Requested one-based line.

path: String

Repository-relative requested path.

LineTooLong

A line cannot fit in the bounded tool result.

Fields

line: u64

One-based line whose content exceeded the cap.

path: String

Repository-relative requested path.

InvalidUtf8

File content is not valid UTF-8 text.

Fields

line: u64

One-based invalid line.

path: String

Repository-relative requested path.

ScanLimitExceeded

The read consumed its bounded file-scan allowance.

Fields

limit: usize

Maximum file bytes one read may consume.

path: String

Repository-relative requested path.

Encode(Error)

The successful result could not be encoded for the model.

Trait Implementations

impl Debug for ReadError

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

Formats the value using the given formatter.

impl Display for ReadError

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

Formats the value using the given formatter.

impl Error for ReadError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for ReadError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ReadError> for TurnError

fn from(source: ReadError) -> Self

Converts to this type from the input type.