Skip to main content

WorkflowPersistence

Struct WorkflowPersistence 

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

Workflow persistence manager

Handles saving and loading workflow contexts to/from disk. Files are stored in JSON format under:

  • ~/.matrix/workflows/ (user/global)
  • .matrix/workflows/ (project-specific)

Implementations§

Source§

impl WorkflowPersistence

Source

pub fn new(project_dir: Option<&PathBuf>) -> Self

Create a new persistence manager with project context

Searches both project and user directories when loading. Saves to project directory if available, else to user directory.

Source

pub fn new_global() -> Self

Create a persistence manager for user directory only (no project context)

Source

pub fn with_base_path(base_path: PathBuf) -> Self

Create a persistence manager with a custom base path

Useful for testing or custom configurations.

Source

pub fn save(&self, context: &WorkflowContext) -> Result<()>

Save a workflow context to disk

The context is serialized to JSON and stored in the save directory (project directory if available, else user directory).

§Example
let persistence = WorkflowPersistence::new(Some(&project_path));
let ctx = WorkflowContext::new("my_workflow".to_string(), HashMap::new());
persistence.save(&ctx)?;
Source

pub fn load(&self, instance_id: &str) -> Result<Option<WorkflowContext>>

Load a workflow context from disk

Searches both project and user directories. Returns Ok(None) if the instance_id does not exist.

§Example
let persistence = WorkflowPersistence::new(Some(&project_path));
if let Some(ctx) = persistence.load("run-123")? {
    println!("Loaded workflow: {}", ctx.workflow_id);
}
Source

pub fn list(&self) -> Result<Vec<WorkflowContext>>

List all saved workflow contexts from both directories

Returns a list of all persisted workflow contexts. Failed loads are logged and skipped.

§Example
let persistence = WorkflowPersistence::new(Some(&project_path));
let workflows = persistence.list()?;
for ctx in workflows {
    println!("{}: {:?}", ctx.instance_id, ctx.status);
}
Source

pub fn delete(&self, instance_id: &str) -> Result<()>

Delete a saved workflow context

Searches both directories and deletes from where it exists. Returns Ok(()) even if the file does not exist.

§Example
let persistence = WorkflowPersistence::new(Some(&project_path));
persistence.delete("run-123")?;
Source

pub fn list_by_status( &self, status: WorkflowStatus, ) -> Result<Vec<WorkflowContext>>

List workflow contexts by status

§Example
let persistence = WorkflowPersistence::new(Some(&project_path));
let paused = persistence.list_by_status(WorkflowStatus::Paused)?;
Source

pub fn save_path(&self) -> &PathBuf

Get the save path (where new workflows will be saved)

Source

pub fn user_path(&self) -> &PathBuf

Get the user path

Source

pub fn project_path(&self) -> Option<&PathBuf>

Get the project path (if available)

Trait Implementations§

Source§

impl Default for WorkflowPersistence

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<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