pub struct ResultsDir { /* private fields */ }Implementations§
Source§impl ResultsDir
impl ResultsDir
Sourcepub fn open(root: &Path) -> Result<Self, ResultsError>
pub fn open(root: &Path) -> Result<Self, ResultsError>
Opens the folder, creating it if needed.
pub fn root(&self) -> &Path
pub fn store(&self) -> &ZarrStore
pub fn save_run( &self, pipeline: &str, recording: &str, manifest: &RunManifest, ) -> Result<(), ResultsError>
pub fn save_summary( &self, summary: &BatchSummary, ) -> Result<PathBuf, ResultsError>
Sourcepub fn run_batch(
&self,
plan: &Plan,
source: &dyn InputSource,
shard: Option<(usize, usize)>,
workers: usize,
on_done: &(dyn Fn(&RecordingRun) + Sync),
) -> Result<BatchSummary, ResultsError>
pub fn run_batch( &self, plan: &Plan, source: &dyn InputSource, shard: Option<(usize, usize)>, workers: usize, on_done: &(dyn Fn(&RecordingRun) + Sync), ) -> Result<BatchSummary, ResultsError>
Runs plan over the recordings in ids (all when None), saving each run as it
finishes and a summary at the end. on_done sees each recording for progress.
pub fn pipelines(&self) -> Vec<String>
Sourcepub fn recordings(&self, pipeline: &str) -> Vec<String>
pub fn recordings(&self, pipeline: &str) -> Vec<String>
Recordings with a saved run, sorted.
pub fn manifest( &self, pipeline: &str, recording: &str, ) -> Result<RunManifest, ResultsError>
Sourcepub fn output(
&self,
pipeline: &str,
recording: &str,
reference: &str,
) -> Result<Arc<Artifact>, ResultsError>
pub fn output( &self, pipeline: &str, recording: &str, reference: &str, ) -> Result<Arc<Artifact>, ResultsError>
A step output, by step.output, or by step when it has one output.
Sourcepub fn export_hdf5(
&self,
pipeline: &str,
dir: &Path,
) -> Result<Vec<PathBuf>, ResultsError>
pub fn export_hdf5( &self, pipeline: &str, dir: &Path, ) -> Result<Vec<PathBuf>, ResultsError>
Writes one HDF5 file per recording to dir, for MATLAB and other tools.
Auto Trait Implementations§
impl Freeze for ResultsDir
impl RefUnwindSafe for ResultsDir
impl Send for ResultsDir
impl Sync for ResultsDir
impl Unpin for ResultsDir
impl UnwindSafe for ResultsDir
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
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more