Skip to main content

MergeStateFile

Struct MergeStateFile 

Source
pub struct MergeStateFile {
    pub phase: MergePhase,
    pub sources: Vec<WorkspaceId>,
    pub epoch_before: EpochId,
    pub frozen_heads: BTreeMap<WorkspaceId, GitOid>,
    pub epoch_candidate: Option<GitOid>,
    pub validation_result: Option<ValidationResult>,
    pub epoch_after: Option<EpochId>,
    pub started_at: u64,
    pub updated_at: u64,
    pub abort_reason: Option<String>,
}
Expand description

The persisted merge-state file.

Written to .manifold/merge-state.json. Every mutation is fsynced to disk so a crash always leaves a valid, recoverable file.

Fields§

§phase: MergePhase

Current merge phase.

§sources: Vec<WorkspaceId>

Source workspaces being merged.

§epoch_before: EpochId

The epoch before this merge started.

§frozen_heads: BTreeMap<WorkspaceId, GitOid>

Frozen workspace HEAD commit OIDs, recorded during PREPARE.

Maps each source workspace to its HEAD at the time inputs were frozen. After PREPARE, these are immutable references — the merge operates on these exact commits regardless of any concurrent workspace activity.

§epoch_candidate: Option<GitOid>

The candidate commit produced during BUILD (set in Build phase).

§validation_result: Option<ValidationResult>

The validation result (set in Validate phase).

§epoch_after: Option<EpochId>

The new epoch after COMMIT (set in Commit phase).

§started_at: u64

Unix timestamp (seconds) when the merge started.

§updated_at: u64

Unix timestamp (seconds) of the last state update.

§abort_reason: Option<String>

Abort reason, if the merge was aborted.

Implementations§

Source§

impl MergeStateFile

Source

pub const fn new( sources: Vec<WorkspaceId>, epoch_before: EpochId, now: u64, ) -> Self

Create a new merge-state file in the Prepare phase.

§Arguments
  • sources - The workspaces being merged.
  • epoch_before - The current epoch at the start of the merge.
  • now - The current Unix timestamp in seconds.
Source

pub fn advance( &mut self, next: MergePhase, now: u64, ) -> Result<(), MergeStateError>

Advance to the next phase, updating the timestamp.

§Errors

Returns MergeStateError::InvalidTransition if the transition is not allowed.

Source

pub fn abort( &mut self, reason: impl Into<String>, now: u64, ) -> Result<(), MergeStateError>

Abort the merge with a reason.

§Errors

Returns MergeStateError::InvalidTransition if the merge is already in a terminal state.

Source

pub fn to_json(&self) -> Result<String, MergeStateError>

Serialize to pretty-printed JSON.

§Errors

Returns MergeStateError::Serialize on serialization failure.

Source

pub fn from_json(json: &str) -> Result<Self, MergeStateError>

Deserialize from a JSON string.

§Errors

Returns MergeStateError::Deserialize on parse failure.

Source

pub fn write_exclusive(&self, path: &Path) -> Result<bool, MergeStateError>

Create the merge-state file exclusively (O_CREAT | O_EXCL).

Uses OpenOptions::create_new(true) so exactly one writer wins. Returns Ok(true) on success, Ok(false) if the file already exists, and Err on any other I/O error.

The write is crash-safe: data is serialized, written, and fsynced directly to the target path. Unlike write_atomic, there is no temp+rename dance because the O_EXCL flag already guarantees the file did not exist.

Source

pub fn write_atomic(&self, path: &Path) -> Result<(), MergeStateError>

Write the merge-state file atomically with fsync.

  1. Serialize to pretty JSON.
  2. Write to a temporary file in the same directory.
  3. fsync the temporary file.
  4. Rename (atomic on POSIX) over the target path.
§Errors

Returns MergeStateError on I/O or serialization failure.

Source

pub fn read(path: &Path) -> Result<Self, MergeStateError>

Read a merge-state file from disk.

§Errors

Returns MergeStateError::NotFound if the file does not exist. Returns MergeStateError::Deserialize if the file is malformed.

Source

pub fn default_path(manifold_dir: &Path) -> PathBuf

Return the default merge-state file path for a .manifold/ directory.

Trait Implementations§

Source§

impl Clone for MergeStateFile

Source§

fn clone(&self) -> MergeStateFile

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 Debug for MergeStateFile

Source§

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

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

impl<'de> Deserialize<'de> for MergeStateFile

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for MergeStateFile

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for MergeStateFile

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for MergeStateFile

Source§

impl StructuralPartialEq for MergeStateFile

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> 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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,