Skip to main content

TransactionError

Enum TransactionError 

Source
#[non_exhaustive]
pub enum TransactionError { Prepare { operation: Option<usize>, source: ReferenceError, }, Publish { outcomes: Vec<RefEditOutcome>, source: ReferenceError, }, }
Expand description

Failure before publication or a report of effects already made.

Self::Prepare leaves ref and log contents unchanged. Self::Publish retains exact outcomes without rollback; a reference may have advanced while its reflog append failed. Retain the outcomes in diagnostics and read fresh state before designing a retry. Replaying the same batch blindly can overwrite intervening work or duplicate log entries.

use girt::refs::{
    Expected, RefEdit, RefName, RefOutcome, ReferenceError, Reflog, Target, TransactionError,
};
use girt::{InitKind, ObjectFormat, Repository};

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

let refs = repo.references()?;
let name = RefName::new("refs/tags/result")?;
let id = repo.loose_objects().write_blob(b"build result")?;

let edit = RefEdit::new(
    name.clone(),
    Some(Target::Direct(id)),
    Expected::Absent,
    Reflog::Preserve,
);

let outcomes = refs.transaction(&[edit.clone()])?;
assert_eq!(outcomes[0].reference, RefOutcome::Published);
assert!(outcomes[0].logs.is_empty());

// A stale creation is refused before publication; don't replace it with Expected::Any.
assert!(matches!(
    refs.transaction(&[edit]),
    Err(TransactionError::Prepare {
        operation: Some(0),
        source: ReferenceError::Mismatch { .. },
    })
));
assert_eq!(refs.read(&name)?, Some(Target::Direct(id)));

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Prepare

No reference or log contents were changed. Empty directories can remain.

Fields

§operation: Option<usize>

Input index when the failure belongs to one operation; otherwise a batch/lock failure.

§source: ReferenceError

Validation, precondition, lock, or read failure.

§

Publish

Publication stopped at the first error, without rollback.

Fields

§outcomes: Vec<RefEditOutcome>

Exact completed effects in caller order; later operations can have packed removals.

§source: ReferenceError

Underlying error. A loose unlink after packed removal retains PackedDeleted.

Trait Implementations§

Source§

impl Debug for TransactionError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for TransactionError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for TransactionError

Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl From<TransactionError> for CloneFailure

Source§

fn from(source: TransactionError) -> Self

Converts to this type from the input type.
Source§

impl From<TransactionError> for Error

Source§

fn from(error: TransactionError) -> Self

Converts to this type from the input type.
Source§

impl From<TransactionError> for FetchFinishFailure

Source§

fn from(source: TransactionError) -> Self

Converts to this type from the input type.
Source§

impl From<TransactionError> for LogError

Source§

fn from(source: TransactionError) -> Self

Converts to this type from the input type.

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more