Enum MaterializeError 

#[non_exhaustive]
pub enum MaterializeError {
    InvalidPathComponent {
        path: Utf8PathBuf,
        component: String,
    },
    NotGitStub {
        path: Utf8PathBuf,
    },
    ReadGitStub {
        path: Utf8PathBuf,
        error: Error,
    },
    InvalidGitStub {
        path: Utf8PathBuf,
        error: GitStubParseError,
    },
    VcsDetect(VcsDetectError),
    ReadContents(ReadContentsError),
    ShallowCloneCheck {
        repo_root: Utf8PathBuf,
        error: ShallowCloneError,
    },
    ShallowClone {
        vcs: VcsName,
        repo_root: Utf8PathBuf,
    },
    CreateDir {
        path: Utf8PathBuf,
        error: Error,
    },
    WriteOutput {
        path: Utf8PathBuf,
        error: AtomicWriteError,
    },
}

Errors that can occur during git stub materialization.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InvalidPathComponent

A path argument contains a non-normal component (e.g., .., ., /, or a Windows prefix).

Only relative paths with plain file and directory names are accepted.

Fields

path: Utf8PathBuf

The full path that failed validation.

component: String

The non-normal component that was found (e.g., .., ., /).

NotGitStub

The path does not have a .gitstub extension.

Fields

path: Utf8PathBuf

The path that was provided.

ReadGitStub

Failed to read the Git stub.

Fields

path: Utf8PathBuf

The path to the Git stub.

error: Error

The underlying I/O error.

InvalidGitStub

The git stub has an invalid format.

Fields

path: Utf8PathBuf

The path to the Git stub.

error: GitStubParseError

Details about the parsing error.

VcsDetect(VcsDetectError)

VCS detection failed.

ReadContents(ReadContentsError)

Failed to read contents from Git.

ShallowCloneCheck

Failed to check whether the repository is a shallow clone.

Fields

repo_root: Utf8PathBuf

The repository root.

error: ShallowCloneError

The underlying error.

ShallowClone

The repository is a shallow clone.

Fields

vcs: VcsName

The VCS detected.

repo_root: Utf8PathBuf

The repository root.

CreateDir

Failed to create output directory.

Fields

path: Utf8PathBuf

The directory path.

error: Error

The underlying I/O error.

WriteOutput

Failed to write the materialized file.

Fields

path: Utf8PathBuf

The path where the write failed.

error: AtomicWriteError

The underlying write error.

Trait Implementations

impl Debug for MaterializeError

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

Formats the value using the given formatter.

impl Display for MaterializeError

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

Formats the value using the given formatter.

impl Error for MaterializeError

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<ReadContentsError> for MaterializeError

fn from(source: ReadContentsError) -> Self

Converts to this type from the input type.

impl From<VcsDetectError> for MaterializeError

fn from(source: VcsDetectError) -> Self

Converts to this type from the input type.