Enum TreeCompareError 

#[non_exhaustive]
pub enum TreeCompareError {
    ObjectFormat(ObjectFormatError),
    Missing {
        id: ObjectId,
        path: Vec<u8>,
    },
    NotTree {
        id: ObjectId,
        path: Vec<u8>,
        actual: ObjectKind,
    },
    Read {
        id: ObjectId,
        path: Vec<u8>,
        source: Box<ObjectReadError>,
    },
    Invalid {
        id: ObjectId,
        path: Vec<u8>,
        source: TreeError,
    },
    Limit(&'static str),
    Unsupported(&'static str),
    Cancelled,
}

A structural comparison failed; no partial result is returned.

A missing or invalid tree needs storage recovery; raising a traversal bound does not repair it. Preserve the ID/path and source chain when reporting TreeCompareError::Read or TreeCompareError::Invalid. Cancellation and limits discard the whole result.

use std::sync::atomic::AtomicBool;

use girt::{InitKind, ObjectFormat, Repository, TreeCompareError};

let directory = tempfile::tempdir()?;
let repo = Repository::init(
    ObjectFormat::Sha1,
    directory.path().join("r"),
    InitKind::Bare,
)?;

let objects = repo.objects_with(Default::default())?;
assert!(matches!(
    objects.compare_trees_with(None, None, Default::default(), &AtomicBool::new(true)),
    Err(TreeCompareError::Cancelled)
));

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.

ObjectFormat(ObjectFormatError)

A root uses a different object format from the reader.

Missing

A tree to be traversed is absent.

Fields

id: ObjectId

Expected tree identity.

path: Vec<u8>

Relative directory path bytes; empty for a root.

NotTree

A visited tree reference resolves to a different object kind.

Fields

id: ObjectId

Expected tree identity.

path: Vec<u8>

Relative directory path bytes; empty for a root.

actual: ObjectKind

Object kind found in storage.

Read

Storage, identity verification or per-read decoding failed.

The effective object-byte limit also includes the remaining cumulative tree-byte budget.

Fields

id: ObjectId

Tree being read.

path: Vec<u8>

Relative directory path bytes; empty for a root.

source: Box<ObjectReadError>

Underlying storage failure. Boxed to keep contextual errors compact.

Invalid

A visited tree has unsupported syntax, invalid names, duplicates or invalid Git ordering.

Fields

id: ObjectId

Tree being parsed or validated.

path: Vec<u8>

Relative directory path bytes; empty for a root.

source: TreeError

Parsing or structural validation failure.

Limit(&'static str)

A named traversal or output bound was exceeded.

Unsupported(&'static str)

The request needs something tree comparison does not provide.

Cancelled

The caller requested cancellation at a cooperative checkpoint.

Trait Implementations

impl Debug for TreeCompareError

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

Formats the value using the given formatter.

impl Display for TreeCompareError

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

Formats the value using the given formatter.

impl Error for TreeCompareError

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<ObjectFormatError> for TreeCompareError

fn from(source: ObjectFormatError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for Error

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for Error

fn from(error: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for SimplifyError

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for ResetError

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for Error

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for Error

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.

impl From<TreeCompareError> for Error

fn from(source: TreeCompareError) -> Self

Converts to this type from the input type.