Struct ChangeLog 

pub struct ChangeLog { /* private fields */ }

Append-only writer for one plugin invocation’s records.

Implementations

impl ChangeLog

pub fn open(project_root: &Path, plugin: &str) -> Result<Self>

Open (creating) the JSONL file for this plugin invocation.

File path: <project_root>/.ready-set/changes/<plugin>-<rfc3339>-<rand4>.jsonl.

Errors

Returns Error::Io if the directory cannot be created or the file cannot be opened, or Error::Other if randomness collection fails.

pub fn file_path(&self) -> &Path

Path to the JSONL file this ChangeLog writes to.

pub fn plugin(&self) -> &str

Plugin name associated with this log.

pub fn project_root(&self) -> &Path

Project root associated with this log.

pub fn record(&mut self, record: &ChangeRecord) -> Result<()>

Append a record. Each record is fsynced before the call returns.

Errors

Returns Error::Io on a write or fsync failure or Error::JsonParse if the record cannot be serialized.

pub fn flush(&mut self) -> Result<()>

Flush buffered records.

Errors

Returns Error::Io on a write or fsync failure.