pub struct SuspendStateStore { /* private fields */ }Expand description
File-store for suspend/resume artifacts under a loop workspace.
Implementations§
Source§impl SuspendStateStore
impl SuspendStateStore
pub fn new(workspace_root: impl AsRef<Path>) -> Self
pub fn workspace_root(&self) -> &Path
pub fn ralph_dir(&self) -> PathBuf
pub fn suspend_state_path(&self) -> PathBuf
pub fn resume_requested_path(&self) -> PathBuf
Sourcepub fn write_suspend_state(
&self,
state: &SuspendStateRecord,
) -> Result<(), SuspendStateStoreError>
pub fn write_suspend_state( &self, state: &SuspendStateRecord, ) -> Result<(), SuspendStateStoreError>
Atomically write suspend-state JSON.
Sourcepub fn read_suspend_state(
&self,
) -> Result<Option<SuspendStateRecord>, SuspendStateStoreError>
pub fn read_suspend_state( &self, ) -> Result<Option<SuspendStateRecord>, SuspendStateStoreError>
Read suspend-state JSON if present.
Sourcepub fn clear_suspend_state(&self) -> Result<bool, SuspendStateStoreError>
pub fn clear_suspend_state(&self) -> Result<bool, SuspendStateStoreError>
Remove suspend-state if present.
Sourcepub fn write_resume_requested(&self) -> Result<(), SuspendStateStoreError>
pub fn write_resume_requested(&self) -> Result<(), SuspendStateStoreError>
Atomically write a resume signal file.
Sourcepub fn is_resume_requested(&self) -> bool
pub fn is_resume_requested(&self) -> bool
True when a resume signal file exists.
Sourcepub fn consume_resume_requested(&self) -> Result<bool, SuspendStateStoreError>
pub fn consume_resume_requested(&self) -> Result<bool, SuspendStateStoreError>
Consume a single-use resume signal file.
Trait Implementations§
Source§impl Clone for SuspendStateStore
impl Clone for SuspendStateStore
Source§fn clone(&self) -> SuspendStateStore
fn clone(&self) -> SuspendStateStore
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for SuspendStateStore
impl RefUnwindSafe for SuspendStateStore
impl Send for SuspendStateStore
impl Sync for SuspendStateStore
impl Unpin for SuspendStateStore
impl UnsafeUnpin for SuspendStateStore
impl UnwindSafe for SuspendStateStore
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more