Enum SubmoduleError 

#[non_exhaustive]
pub enum SubmoduleError {
    EmptyPath,
    SymlinkInPath {
        path: String,
        component: String,
    },
    GitDirNameMismatch {
        name: String,
        git_dir: PathBuf,
    },
    GitDirNested {
        name: String,
    },
    GitDirOutsideModules {
        git_dir: PathBuf,
    },
    GitDirSegmentHasSlash {
        git_dir: PathBuf,
    },
    GitDirInUse {
        name: String,
        git_dir: PathBuf,
    },
    GitDirCaseConflict {
        name: String,
        git_dir: PathBuf,
    },
    GitDirUnavailable {
        name: String,
    },
    GitDirNotConfigured {
        name: String,
    },
    HeadUnreadable {
        path: String,
    },
    HeadCommitMissing {
        path: String,
    },
}

Submodule layout and state failures: where a submodule’s git directory lives and whether its checkout can be inspected.

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.

EmptyPath

The submodule path is empty.

SymlinkInPath

A component of the submodule path is a symbolic link, so the path could escape the work tree.

Fields

path: String

Submodule path relative to the work tree.

component: String

The component that is a symbolic link.

GitDirNameMismatch

A legacy submodule git dir (modules/<name>) does not end with /<name>.

Fields

name: String

Submodule name.

git_dir: PathBuf

Git directory that was checked.

GitDirNested

A submodule git dir lies inside another submodule’s git dir.

Fields

name: String

Submodule name.

GitDirOutsideModules

An encoded submodule git dir has no modules/ path segment.

Fields

git_dir: PathBuf

Git directory that was checked.

GitDirSegmentHasSlash

The segment after modules/ in an encoded submodule git dir contains /.

Fields

git_dir: PathBuf

Git directory that was checked.

GitDirInUse

Another submodule already uses this git dir.

Fields

name: String

Submodule name.

git_dir: PathBuf

Git directory that was checked.

GitDirCaseConflict

This git dir differs from another submodule’s only by case, on a case-insensitive file system.

Fields

name: String

Submodule name.

git_dir: PathBuf

Git directory that was checked.

GitDirUnavailable

Every candidate git dir for a new submodule was invalid or already taken.

Fields

name: String

Submodule name.

GitDirNotConfigured

submodulePathConfig is enabled but submodule.<name>.gitdir is not set.

Fields

name: String

Submodule name.

HeadUnreadable

The submodule has an embedded git dir but its HEAD could not be read.

Fields

path: String

Submodule path relative to the superproject work tree.

HeadCommitMissing

The submodule’s HEAD names an object that is missing or is not a commit.

Fields

path: String

Submodule path relative to the superproject work tree.

Trait Implementations

impl Clone for SubmoduleError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubmoduleError

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

Formats the value using the given formatter.

impl Display for SubmoduleError

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

Formats the value using the given formatter.

impl Eq for SubmoduleError

impl Error for SubmoduleError

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<SubmoduleError> for Error

fn from(source: SubmoduleError) -> Self

Converts to this type from the input type.

impl PartialEq for SubmoduleError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SubmoduleError