Skip to main content

Journal

Struct Journal 

Source
pub struct Journal {
    pub dir: PathBuf,
    /* private fields */
}
Expand description

One open journal.

Fields§

§dir: PathBuf

The run’s directory.

Implementations§

Source§

impl Journal

Source

pub fn create( command: &str, target: &str, forge: &str, repo: &str, ) -> Result<Self>

Create the run directory — before any remote mutation — pruning the oldest runs past the cap first.

§Errors

Any filesystem failure; the caller decides whether that refuses the run (apply) or only costs the record (preview and check).

Source

pub fn run_id(&self) -> &str

The run’s identifier.

Source

pub fn scripts_dir(&self) -> PathBuf

The directory the run’s scripts materialize into.

Source

pub fn event_line(&mut self, line: &str)

Append one already-serialized event line.

Source

pub fn transcript(&mut self, bytes: &[u8])

Append raw bytes to the transcript, in arrival order.

Source

pub fn record_script(&mut self, path: String, sha256: String)

Record one materialized script’s digest.

Source

pub fn record_secret( &mut self, secret: &str, present: bool, source: &'static str, )

Record one secret’s handling: where the value came from, and how it reached the forge CLI. A key file is file, because the environment carried only its path.

Source

pub fn finish(&mut self, exit_code: i32, reason: Option<&str>)

Close the run: record the terminal status, and remove the materialized scripts on clean completion so a failed run keeps exactly the script that ran beside the transcript of what it did.

Trait Implementations§

Source§

impl Debug for Journal

Source§

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

Formats the value using the given formatter. Read more

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, 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, 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.