Skip to main content

DraftStore

Struct DraftStore 

Source
pub struct DraftStore { /* private fields */ }
Expand description

Filesystem-backed draft surface.

Implementations§

Source§

impl DraftStore

Source

pub fn new(root: impl AsRef<Path>) -> Self

Construct a store rooted at drafts_dir.

Source

pub fn root(&self) -> &Path

Root drafts directory.

Source

pub fn state_dir(&self, state: DraftState) -> PathBuf

Directory for a lifecycle state.

Source

pub fn path_for(&self, state: DraftState, id: DraftId) -> PathBuf

Canonical path for a draft in a lifecycle state.

Source

pub fn ensure_dirs(&self) -> Result<(), LibrarianError>

Ensure all lifecycle directories exist.

§Errors

Returns LibrarianError::DraftIo when a lifecycle directory cannot be created.

Source

pub fn submit(&self, draft: &Draft) -> Result<PathBuf, LibrarianError>

Submit a draft into pending/ as a v2 JSON envelope.

If the target file already exists, submission is treated as idempotent and the existing path is returned.

§Errors

Returns LibrarianError::DraftIo if the directory or file operations fail, or LibrarianError::DraftJson if the draft envelope cannot be encoded.

Source

pub fn load( &self, state: DraftState, id: DraftId, ) -> Result<Draft, LibrarianError>

Load one draft from a state directory.

§Errors

Returns LibrarianError::DraftIo if the file cannot be read, LibrarianError::DraftJson if it is not valid JSON, LibrarianError::UnsupportedDraftSchema for unknown schema versions, or LibrarianError::DraftIdMismatch if the stored ID does not match the envelope.

Source

pub fn list(&self, state: DraftState) -> Result<Vec<Draft>, LibrarianError>

List drafts in one state directory.

§Errors

Returns the same errors as DraftStore::load for any listed draft, and LibrarianError::DraftIo if the state directory cannot be read.

Source

pub fn transition( &self, id: DraftId, from: DraftState, to: DraftState, ) -> Result<DraftTransition, LibrarianError>

Move a draft from one lifecycle state to another.

The state graph is intentionally small:

  • pending -> processing claims work for a run.
  • processing -> accepted | skipped | failed | quarantined finishes work.
  • processing -> pending recovers stale in-flight work after a crash or abandoned run.

The file move is a single filesystem rename. The method refuses to overwrite an existing target path.

§Errors

Returns LibrarianError::InvalidDraftTransition for edges outside the lifecycle graph, LibrarianError::DraftNotFound when the source file is absent, LibrarianError::DraftAlreadyExists when the target path is already occupied, or the same load / I/O errors as DraftStore::load.

Source

pub fn recover_stale_processing( &self, stale_before: SystemTime, ) -> Result<Vec<DraftTransition>, LibrarianError>

Recover stale drafts from processing/ back to pending/.

A processing draft is stale when its claim marker modified time is at or before stale_before. Callers usually pass SystemTime::now() - processing_timeout; tests can pass a future cutoff to recover all processing drafts deterministically.

§Errors

Returns the same errors as DraftStore::transition for any stale draft that cannot be moved, plus LibrarianError::DraftIo for directory iteration or metadata errors.

Trait Implementations§

Source§

impl Clone for DraftStore

Source§

fn clone(&self) -> DraftStore

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DraftStore

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more