pub struct BatchWorkspace { /* private fields */ }Implementations§
Source§impl BatchWorkspace
impl BatchWorkspace
pub fn workdir(&self) -> &PathBuf
pub fn logdir(&self) -> &PathBuf
pub fn done_dir(&self) -> &PathBuf
pub fn failed_items_dir(&self) -> &PathBuf
pub fn target_dir(&self) -> &PathBuf
pub fn failed_json_repairs_dir(&self) -> &PathBuf
pub fn temp_dir(&self) -> &Option<TempDir>
pub fn temporary(&self) -> &bool
Source§impl BatchWorkspace
impl BatchWorkspace
pub fn set_workdir(&mut self, val: PathBuf) -> &mut BatchWorkspace
pub fn set_logdir(&mut self, val: PathBuf) -> &mut BatchWorkspace
pub fn set_done_dir(&mut self, val: PathBuf) -> &mut BatchWorkspace
pub fn set_failed_items_dir(&mut self, val: PathBuf) -> &mut BatchWorkspace
pub fn set_target_dir(&mut self, val: PathBuf) -> &mut BatchWorkspace
pub fn set_failed_json_repairs_dir( &mut self, val: PathBuf, ) -> &mut BatchWorkspace
pub fn set_temp_dir(&mut self, val: Option<TempDir>) -> &mut BatchWorkspace
pub fn set_temporary(&mut self, val: bool) -> &mut BatchWorkspace
Source§impl BatchWorkspace
impl BatchWorkspace
pub async fn find_existing_triple_with_given_index( self: Arc<BatchWorkspace>, index: &BatchIndex, ) -> Result<BatchFileTriple, BatchWorkspaceError>
pub async fn new_in( product_root: impl AsRef<Path>, ) -> Result<Arc<BatchWorkspace>, BatchWorkspaceError>
pub async fn new_temp() -> Result<Arc<BatchWorkspace>, BatchWorkspaceError>
pub async fn new_mock() -> Result<Arc<BatchWorkspace>, BatchWorkspaceError>
pub fn batch_expansion_error_log_filename( &self, batch_idx: &BatchIndex, ) -> PathBuf
Trait Implementations§
Source§impl CloneAsFreshTemporary for BatchWorkspace
The robust approach for “deep cloning” a workspace into a new TempDir.
impl CloneAsFreshTemporary for BatchWorkspace
The robust approach for “deep cloning” a workspace into a new TempDir.
fn clone_as_fresh_temp(&self) -> Result<BatchWorkspace, Error>
Source§impl Debug for BatchWorkspace
impl Debug for BatchWorkspace
Source§impl DeepClone for BatchWorkspace
impl DeepClone for BatchWorkspace
type Error = BatchWorkspaceError
Source§fn deep_clone(
&self,
) -> Result<BatchWorkspace, <BatchWorkspace as DeepClone>::Error>
fn deep_clone( &self, ) -> Result<BatchWorkspace, <BatchWorkspace as DeepClone>::Error>
Creates a new temporary directory, copies the original’s directory contents into it, and
returns a new
BatchWorkspace that references this new environment.Source§impl GetDoneDirectory for BatchWorkspace
impl GetDoneDirectory for BatchWorkspace
fn get_done_directory(&self) -> &PathBuf
Source§impl GetErrorFilenameAtIndex for BatchWorkspace
impl GetErrorFilenameAtIndex for BatchWorkspace
fn error_filename(&self, batch_idx: &BatchIndex) -> PathBuf
Source§impl GetFailedItemsDir for BatchWorkspace
impl GetFailedItemsDir for BatchWorkspace
fn failed_items_dir(&self) -> PathBuf
Source§impl GetFailedJsonRepairsDir for BatchWorkspace
impl GetFailedJsonRepairsDir for BatchWorkspace
fn failed_json_repairs_dir(&self) -> PathBuf
Source§impl GetInputFilenameAtIndex for BatchWorkspace
impl GetInputFilenameAtIndex for BatchWorkspace
fn input_filename(&self, batch_idx: &BatchIndex) -> PathBuf
Source§impl GetMetadataFilenameAtIndex for BatchWorkspace
impl GetMetadataFilenameAtIndex for BatchWorkspace
fn metadata_filename(&self, batch_idx: &BatchIndex) -> PathBuf
Source§impl GetOutputFilenameAtIndex for BatchWorkspace
impl GetOutputFilenameAtIndex for BatchWorkspace
fn output_filename(&self, batch_idx: &BatchIndex) -> PathBuf
Source§impl GetTargetDir for BatchWorkspace
impl GetTargetDir for BatchWorkspace
fn get_target_dir(&self) -> PathBuf
Source§impl GetTargetPath for BatchWorkspace
impl GetTargetPath for BatchWorkspace
type Item = Arc<dyn GetTargetPathForAIExpansion + Send + Sync>
fn target_path( &self, item: &<BatchWorkspace as GetTargetPath>::Item, expected_content_type: &ExpectedContentType, ) -> PathBuf
Source§impl GetTextStoragePath for BatchWorkspace
impl GetTextStoragePath for BatchWorkspace
fn text_storage_path(&self, batch_idx: &BatchIndex) -> PathBuf
Source§impl GetWorkdir for BatchWorkspace
impl GetWorkdir for BatchWorkspace
Source§impl PartialEq for BatchWorkspace
impl PartialEq for BatchWorkspace
impl BatchWorkspaceInterface for BatchWorkspace
impl Eq for BatchWorkspace
impl Send for BatchWorkspace
impl Sync for BatchWorkspace
Auto Trait Implementations§
impl Freeze for BatchWorkspace
impl RefUnwindSafe for BatchWorkspace
impl Unpin for BatchWorkspace
impl UnwindSafe for BatchWorkspace
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<W, T> CalculateUnseenInputs<T> for Wwhere
W: FindSimilarTargetPath + GetTargetDir,
T: GetTargetPathForAIExpansion + Clone + Debug + Display + Named,
impl<W, T> CalculateUnseenInputs<T> for Wwhere
W: FindSimilarTargetPath + GetTargetDir,
T: GetTargetPathForAIExpansion + Clone + Debug + Display + Named,
Source§fn calculate_unseen_inputs(
&self,
inputs: &[T],
expected_content_type: &ExpectedContentType,
) -> Vec<T>
fn calculate_unseen_inputs( &self, inputs: &[T], expected_content_type: &ExpectedContentType, ) -> Vec<T>
Internal helper. Identifies newly seen tokens.
Source§impl<T> FindExistingBatchFileIndices for T
impl<T> FindExistingBatchFileIndices for T
type Error = BatchWorkspaceError
fn find_existing_batch_file_indices<'async_trait>(
self: Arc<T>,
) -> Pin<Box<dyn Future<Output = Result<HashSet<BatchIndex>, <T as FindExistingBatchFileIndices>::Error>> + Send + 'async_trait>>where
T: 'async_trait,
Source§impl<W> FindSimilarTargetPath for Wwhere
W: GetTargetDirectoryFiles,
impl<W> FindSimilarTargetPath for Wwhere
W: GetTargetDirectoryFiles,
Source§impl<T> GatherAllBatchTriples for Twhere
T: for<'async_trait> LocateBatchFiles + for<'async_trait> FindExistingBatchFileIndices + for<'async_trait> Send + for<'async_trait> Sync + 'async_trait,
BatchWorkspaceError: From<<T as LocateBatchFiles>::Error> + From<<T as FindExistingBatchFileIndices>::Error>,
impl<T> GatherAllBatchTriples for Twhere
T: for<'async_trait> LocateBatchFiles + for<'async_trait> FindExistingBatchFileIndices + for<'async_trait> Send + for<'async_trait> Sync + 'async_trait,
BatchWorkspaceError: From<<T as LocateBatchFiles>::Error> + From<<T as FindExistingBatchFileIndices>::Error>,
type Error = BatchWorkspaceError
fn gather_all_batch_triples<'async_trait>(
self: Arc<T>,
) -> Pin<Box<dyn Future<Output = Result<Vec<BatchFileTriple>, <T as GatherAllBatchTriples>::Error>> + Send + 'async_trait>>where
T: 'async_trait,
Source§impl<W> GetTargetDirectoryFiles for Wwhere
W: GetTargetDir,
impl<W> GetTargetDirectoryFiles for Wwhere
W: GetTargetDir,
fn get_target_directory_files(&self) -> Vec<PathBuf>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> LocateBatchFiles for T
impl<T> LocateBatchFiles for T
type Error = BatchWorkspaceError
fn locate_batch_files<'life0, 'async_trait>(
self: Arc<T>,
index: &'life0 BatchIndex,
) -> Pin<Box<dyn Future<Output = Result<Option<BatchFileTriple>, <T as LocateBatchFiles>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
T: 'async_trait,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);