Skip to main content

CommitOptions

Struct CommitOptions 

Source
pub struct CommitOptions<'a> {
    pub author: &'a str,
    pub message: &'a str,
    pub linearize: bool,
    pub time_micros: Option<u64>,
    pub change_id: Option<ChangeId>,
}
Expand description

Options controlling the commit path.

The default (via Transaction::commit) is lock-free: concurrent writers both succeed; the next reader merges. Setting linearize to true enables SPEC §6.5 opportunistic concurrency - if any other writer has advanced op-heads since this transaction started, the commit fails with RepoError::Stale instead of appending a concurrent head.

Fields§

§author: &'a str

Commit author (UTF-8, stored on the new Commit + Operation).

§message: &'a str

Commit message.

§linearize: bool

Opt-in SPEC §6.5 linearize mode. Defaults to false.

§time_micros: Option<u64>

Override the commit + operation timestamp. Measured in microseconds since Unix epoch. None (the default) calls SystemTime::now() at commit time, which is what a human workflow wants.

Set this to Some(...) when byte-identical CIDs across machines matter: two processes that build the same logical commit (same author, same message, same graph mutations, same time, same change_id) will produce the same commit CID and the same op-id. This is the escape hatch for audit-replay, distributed-agent consensus, and regression tests that assert on commit CIDs.

§change_id: Option<ChangeId>

Override the commit’s change_id. None (the default) generates a fresh ChangeId::new_v7(), which embeds wall- clock time and therefore varies per call. Deterministic- replay workflows MUST supply this explicitly alongside time_micros; otherwise the v7 randomness alone defeats the byte-identical-CID contract.

Implementations§

Source§

impl<'a> CommitOptions<'a>

Source

pub const fn new(author: &'a str, message: &'a str) -> Self

Construct with all deterministic-override fields set to None (the caller-convenient default: auto-clock + auto-change-id).

Source

pub const fn with_time_micros(self, t: u64) -> Self

Pin the timestamp for deterministic replay. See Self::time_micros for the wider contract.

Source

pub const fn with_change_id(self, id: ChangeId) -> Self

Pin the change-id for deterministic replay. See Self::change_id for the wider contract.

Trait Implementations§

Source§

impl<'a> Clone for CommitOptions<'a>

Source§

fn clone(&self) -> CommitOptions<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for CommitOptions<'a>

Source§

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

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

impl<'a> Copy for CommitOptions<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for CommitOptions<'a>

§

impl<'a> RefUnwindSafe for CommitOptions<'a>

§

impl<'a> Send for CommitOptions<'a>

§

impl<'a> Sync for CommitOptions<'a>

§

impl<'a> Unpin for CommitOptions<'a>

§

impl<'a> UnsafeUnpin for CommitOptions<'a>

§

impl<'a> UnwindSafe for CommitOptions<'a>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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