Struct Journal 

pub struct Journal { /* private fields */ }

Implementations

impl Journal

pub fn stable_file_name( directory: &Path, adapter_name: &str, ops: &[Op], ) -> PathBuf

pub fn load_or_create( directory: &Path, adapter_name: &str, ops: &[Op], ) -> Result<Self>

tries to load a Journal from file_path, otherwise creates a new one. in either case, the new Journal instance will be backed by the file at file_path. delete ops will not be saved in the journal.

pub fn new_ephemeral(ops: &[Op]) -> Self

creates a journal without a backing file set

pub fn done_ops(&self) -> Vec<(Uid, TypeName, u64)>

pub fn done_ops_count(&self) -> usize

pub fn is_completed(&self) -> bool

pub fn mark_op_as_done(&mut self, op: &Op) -> Result<()>

will mark the first op that is not done (will fail if there’s no such op). uses a linear search from the start.

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

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

Trait Implementations

impl Debug for Journal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Journal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Journal

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Serialize for Journal

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

where __S: Serializer,

Serialize this value into the given Serde serializer.