Struct BatchFileTriple

pub struct BatchFileTriple { /* private fields */ }

Represents the batch files associated with a specific index.

Implementations

impl BatchFileTriple

pub async fn ensure_input_matches_output_and_error( &self, ) -> Result<(), BatchValidationError>

impl BatchFileTriple

pub fn index(&self) -> &BatchIndex

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

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

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

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

pub fn workspace( &self, ) -> &Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>

impl BatchFileTriple

pub fn new_for_test_with_workspace( workspace: Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>, ) -> BatchFileTriple

A convenience constructor for tests that supply a custom workspace. Everything else is None, and we assign a dummy index.

pub fn new_for_test_empty() -> BatchFileTriple

Some tests referred to “new_for_test_empty()”. We define it here as a convenience constructor that sets everything to None, with a dummy index and a MockBatchWorkspace.

pub fn set_index(&mut self, new_index: BatchIndex)

Some tests set the index after constructing. We add a trivial setter:

pub fn effective_input_filename(&self) -> PathBuf

pub fn effective_output_filename(&self) -> PathBuf

pub fn effective_error_filename(&self) -> PathBuf

pub fn effective_metadata_filename(&self) -> PathBuf

impl BatchFileTriple

pub fn new_for_test_unique( workspace: Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>, ) -> BatchFileTriple

pub fn new_for_test_with_metadata_path_unique( metadata_path: PathBuf, ) -> BatchFileTriple

pub fn get_done_directory(&self) -> &PathBuf

pub fn set_output_path(&mut self, path: Option<PathBuf>)

pub fn set_input_path(&mut self, path: Option<PathBuf>)

pub fn set_metadata_path(&mut self, path: Option<PathBuf>)

pub fn set_error_path(&mut self, path: Option<PathBuf>)

pub fn all_are_none(&self) -> bool

pub fn new_with_requests( requests: &[LanguageModelBatchAPIRequest], workspace: Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>, ) -> Result<BatchFileTriple, BatchInputCreationError>

pub fn new_direct( index: &BatchIndex, input: Option<PathBuf>, output: Option<PathBuf>, error: Option<PathBuf>, associated_metadata: Option<PathBuf>, workspace: Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>, ) -> BatchFileTriple

pub fn new_for_test_with_metadata_path( metadata_path: PathBuf, ) -> BatchFileTriple

A convenience constructor used by certain unit tests that only need to set associated_metadata while leaving other paths as None. We assign a dummy BatchIndex and a default MockBatchWorkspace (or any real workspace).

pub fn new_for_test_with_in_out_err_paths( workspace: Arc<dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>>, input: PathBuf, output: Option<PathBuf>, error: Option<PathBuf>, ) -> BatchFileTriple

A convenience constructor used by certain unit tests that need to set specific input, output, and error paths directly (often to temp files). We assign a dummy BatchIndex and a default MockBatchWorkspace.

impl BatchFileTriple

pub async fn move_input_and_output_to_done(&self) -> Result<(), FileMoveError>

pub async fn move_input_and_error_to_done(&self) -> Result<(), FileMoveError>

pub async fn move_all_to_done(&self) -> Result<(), FileMoveError>

impl BatchFileTriple

pub async fn ensure_input_matches_output( &self, ) -> Result<(), BatchValidationError>

impl BatchFileTriple

pub async fn ensure_input_matches_error( &self, ) -> Result<(), BatchValidationError>

impl BatchFileTriple

pub async fn retry_failed_requests( &self, error_data: &BatchErrorData, ) -> Result<(), BatchErrorProcessingError>

impl BatchFileTriple

pub async fn log_errors( &self, error_data: &BatchErrorData, ) -> Result<(), BatchErrorProcessingError>

Trait Implementations

impl<E> CheckBatchStatusOnline<E> for BatchFileTriple

where E: From<BatchDownloadError> + From<OpenAIClientError> + From<BatchMetadataError> + From<Error> + Debug,

fn check_batch_status_online<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, ) -> Pin<Box<dyn Future<Output = Result<BatchOnlineStatus, E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchFileTriple: 'async_trait,

impl<E> CheckForAndDownloadOutputAndErrorOnline<E> for BatchFileTriple

where E: From<BatchDownloadError> + From<OpenAIClientError> + From<BatchMetadataError> + From<Error> + Debug + Display,

fn check_for_and_download_output_and_error_online<'life0, 'life1, 'async_trait>( &'life0 mut self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchFileTriple: 'async_trait,

impl Clone for BatchFileTriple

fn clone(&self) -> BatchFileTriple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchFileTriple

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<E> DownloadErrorFile<E> for BatchFileTriple

where E: From<BatchDownloadError> + From<Error> + From<BatchMetadataError> + From<OpenAIClientError> + Debug,

fn download_error_file<'life0, 'life1, 'async_trait>( &'life0 mut self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchFileTriple: 'async_trait,

impl<E> DownloadOutputFile<E> for BatchFileTriple

where E: From<BatchDownloadError> + From<Error> + From<BatchMetadataError> + From<OpenAIClientError> + Debug,

fn download_output_file<'life0, 'life1, 'async_trait>( &'life0 mut self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchFileTriple: 'async_trait,

impl<E> ExecuteReconciliationOperation<E> for BatchFileTriple

where E: From<BatchReconciliationError> + From<BatchDownloadError> + From<OpenAIClientError> + From<BatchMetadataError> + From<Error> + From<FileMoveError> + From<BatchOutputProcessingError> + From<BatchErrorProcessingError> + From<BatchValidationError> + Display + Debug,

fn execute_reconciliation_operation<'life0, 'life1, 'life2, 'life3, 'life4, 'life5, 'async_trait>( &'life0 mut self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, operation: &'life2 BatchFileTripleReconciliationOperation, expected_content_type: &'life3 ExpectedContentType, process_output_file_fn: &'life4 for<'a> fn(&'a BatchFileTriple, &'a dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>, &'a ExpectedContentType) -> Pin<Box<dyn Future<Output = Result<(), BatchOutputProcessingError>> + Send + 'a>>, process_error_file_fn: &'life5 for<'a> fn(&'a BatchFileTriple, &'a [BatchErrorFileProcessingOperation]) -> Pin<Box<dyn Future<Output = Result<(), BatchErrorProcessingError>> + Send + 'a>>, ) -> Pin<Box<dyn Future<Output = Result<Option<BatchFileReconciliationRecommendedCourseOfAction>, E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, 'life5: 'async_trait, BatchFileTriple: 'async_trait,

impl<C, E> FreshExecute<C, E> for BatchFileTriple

where C: LanguageModelClientInterface<E>, E: Debug + Display + From<BatchProcessingError> + From<BatchDownloadError> + From<JsonParseError> + From<Error> + From<OpenAIClientError> + From<BatchMetadataError>,

type Success = BatchExecutionResult

fn fresh_execute<'life0, 'life1, 'async_trait>( &'life0 mut self, client: &'life1 C, ) -> Pin<Box<dyn Future<Output = Result<BatchExecutionResult, E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, BatchFileTriple: 'async_trait,

impl From<&BatchFileTriple> for BatchFileState

fn from(triple: &BatchFileTriple) -> BatchFileState

Determines the state of the batch files.

impl Ord for BatchFileTriple

fn cmp(&self, other: &BatchFileTriple) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BatchFileTriple

fn eq(&self, other: &BatchFileTriple) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BatchFileTriple

fn partial_cmp(&self, other: &BatchFileTriple) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RecalculateRecommendedActions for BatchFileTriple

fn recalculate_recommended_actions( &self, ) -> Result<BatchFileReconciliationRecommendedCourseOfAction, BatchReconciliationError>

impl<E> ReconcileUnprocessed<E> for BatchFileTriple

where E: From<BatchReconciliationError> + From<BatchDownloadError> + From<BatchErrorProcessingError> + From<BatchMetadataError> + From<BatchOutputProcessingError> + From<BatchValidationError> + From<FileMoveError> + From<OpenAIClientError> + From<Error> + Display + Debug + Send + Sync,

fn reconcile_unprocessed<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 mut self, client: &'life1 dyn LanguageModelClientInterface<E, Error = E, Error = E, Error = E, Error = E, Error = E>, expected_content_type: &'life2 ExpectedContentType, process_output_file_fn: &'life3 for<'a> fn(&'a BatchFileTriple, &'a dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Sync + Send>>, &'a ExpectedContentType) -> Pin<Box<dyn Future<Output = Result<(), BatchOutputProcessingError>> + Send + 'a>>, process_error_file_fn: &'life4 for<'a> fn(&'a BatchFileTriple, &'a [BatchErrorFileProcessingOperation]) -> Pin<Box<dyn Future<Output = Result<(), BatchErrorProcessingError>> + Send + 'a>>, ) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, BatchFileTriple: 'async_trait,

impl TryFrom<&BatchFileTriple> for BatchFileReconciliationRecommendedCourseOfAction

type Error = BatchReconciliationError

The type returned in the event of a conversion error.

fn try_from( triple: &BatchFileTriple, ) -> Result<BatchFileReconciliationRecommendedCourseOfAction, BatchReconciliationError>

Performs the conversion.

impl<E> CheckAndDownloadInterface<E> for BatchFileTriple

where E: From<BatchDownloadError> + From<OpenAIClientError> + From<BatchMetadataError> + From<Error> + Debug + Display,

impl Eq for BatchFileTriple

impl Send for BatchFileTriple

impl Sync for BatchFileTriple