Struct Journal 

pub struct Journal {
    pub phase: Phase,
    pub token: String,
    pub path: Vec<u8>,
    pub old_identity: ObjectId,
    pub git_file: Vec<u8>,
    pub new_identity: Option<ObjectId>,
}

What: The journal of one conversion, kept in the worktree’s administrative directory. Why: See the module description.

In TS you’d write (pseudocode):

type ConvertJournal = { phase: Phase; token: string; path: string; oldIdentity: ObjectId; gitFile: Uint8Array; newIdentity?: ObjectId };

Fields

phase: Phase

The phase reached.

token: String

The token the index lock holds.

path: Vec<u8>

The worktree path as raw bytes.

old_identity: ObjectId

The identity of the old root: device, inode and, where the filesystem gives one, the birth time, which tells the recorded directory from another that later got the same inode number.

git_file: Vec<u8>

The exact bytes of the .git file.

new_identity: Option<ObjectId>

The identity of the subvolume this command created, recorded right after the creation; absent until then, so a directory at the converting name that the journal has no identity for is foreign.

Implementations

impl Journal

pub fn save(&self, admin: &Path) -> Result<(), MigrateError>

Replace the journal with this one: written beside it, synchronized, renamed into place.

pub fn create_new(&self, admin: &Path) -> Result<(), MigrateError>

Make this the journal of a conversion that has none: it fails when any journal exists, so a journal another command made is never replaced.

pub fn load(admin: &Path) -> Result<Option<Journal>, MigrateError>

The journal of an administrative directory, if one exists.

Trait Implementations

impl Clone for Journal

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 Journal

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

Formats the value using the given formatter.

impl Eq for Journal

impl PartialEq for Journal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Journal