pub struct WorkflowParser { /* private fields */ }Expand description
Parser for loading workflow templates from YAML files.
Implementations§
Source§impl WorkflowParser
impl WorkflowParser
Sourcepub fn new(workflows_dir: impl Into<PathBuf>) -> Self
pub fn new(workflows_dir: impl Into<PathBuf>) -> Self
Create a new parser for the given workflows directory.
Sourcepub fn from_repo_root(repo_root: impl AsRef<Path>) -> Self
pub fn from_repo_root(repo_root: impl AsRef<Path>) -> Self
Create a parser from a repository root.
Looks for workflows in .brat/workflows/.
Sourcepub fn workflows_dir(&self) -> &Path
pub fn workflows_dir(&self) -> &Path
Get the workflows directory path.
Sourcepub fn workflows_dir_exists(&self) -> bool
pub fn workflows_dir_exists(&self) -> bool
Check if the workflows directory exists.
Sourcepub fn list_workflows(&self) -> Result<Vec<String>, WorkflowError>
pub fn list_workflows(&self) -> Result<Vec<String>, WorkflowError>
List available workflow names.
Sourcepub fn load(&self, name: &str) -> Result<WorkflowTemplate, WorkflowError>
pub fn load(&self, name: &str) -> Result<WorkflowTemplate, WorkflowError>
Load a workflow by name.
Sourcepub fn load_from_path(
&self,
path: &Path,
) -> Result<WorkflowTemplate, WorkflowError>
pub fn load_from_path( &self, path: &Path, ) -> Result<WorkflowTemplate, WorkflowError>
Load a workflow from a specific path.
Auto Trait Implementations§
impl Freeze for WorkflowParser
impl RefUnwindSafe for WorkflowParser
impl Send for WorkflowParser
impl Sync for WorkflowParser
impl Unpin for WorkflowParser
impl UnwindSafe for WorkflowParser
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