pub struct AiReadmeWriter { /* private fields */ }Implementations§
Source§impl AiReadmeWriter
impl AiReadmeWriter
pub fn language_model_client( &self, ) -> &Arc<dyn LanguageModelClientInterface<LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError>>
pub fn language_model_type(&self) -> &LanguageModelType
pub fn batch_workspace(&self) -> &Arc<BatchWorkspace>
Source§impl AiReadmeWriter
impl AiReadmeWriter
Sourcepub const AIREADMEWRITER_OUTPUT_FILE_BRIDGE: for<'a> fn(&'a BatchFileTriple, &'a dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Send + Sync>>, &'a ExpectedContentType) -> Pin<Box<dyn Future<Output = Result<(), BatchOutputProcessingError>> + Send + 'a>> = {workspacer_readme_writer::AiReadmeWriter::AiReadmeWriter_output_file_bridge_fn as for<'a> fn(&'a workspacer_3p::BatchFileTriple, &'a (dyn workspacer_3p::BatchWorkspaceInterface + 'a), &'a workspacer_3p::ExpectedContentType) -> std::pin::Pin<std::boxed::Box<(dyn std::future::Future<Output = std::result::Result<(), workspacer_3p::BatchOutputProcessingError>> + std::marker::Send + 'a)>>}
pub const AIREADMEWRITER_OUTPUT_FILE_BRIDGE: for<'a> fn(&'a BatchFileTriple, &'a dyn BatchWorkspaceInterface<Item = Arc<dyn GetTargetPathForAIExpansion + Send + Sync>>, &'a ExpectedContentType) -> Pin<Box<dyn Future<Output = Result<(), BatchOutputProcessingError>> + Send + 'a>> = {workspacer_readme_writer::AiReadmeWriter::AiReadmeWriter_output_file_bridge_fn as for<'a> fn(&'a workspacer_3p::BatchFileTriple, &'a (dyn workspacer_3p::BatchWorkspaceInterface + 'a), &'a workspacer_3p::ExpectedContentType) -> std::pin::Pin<std::boxed::Box<(dyn std::future::Future<Output = std::result::Result<(), workspacer_3p::BatchOutputProcessingError>> + std::marker::Send + 'a)>>}
A public constant pointer to that bridging function, matching BatchWorkflowProcessOutputFileFn.
Source§impl AiReadmeWriter
impl AiReadmeWriter
pub async fn default() -> Result<AiReadmeWriter, AiReadmeWriterError>
pub async fn new( workspace_root: impl AsRef<Path>, language_model_type: LanguageModelType, ) -> Result<AiReadmeWriter, AiReadmeWriterError>
Trait Implementations§
Source§impl ComputeLanguageModelCoreQuery for AiReadmeWriter
impl ComputeLanguageModelCoreQuery for AiReadmeWriter
Source§type Seed = AiReadmeWriterRequest<PathBuf>
type Seed = AiReadmeWriterRequest<PathBuf>
Source§fn compute_language_model_core_query(
&self,
input: &<AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed,
) -> String
fn compute_language_model_core_query( &self, input: &<AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed, ) -> String
compute_language_model_requests().Source§impl ComputeLanguageModelRequests for AiReadmeWriter
impl ComputeLanguageModelRequests for AiReadmeWriter
type Seed = <AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed
Source§fn compute_language_model_requests(
&self,
model: &LanguageModelType,
inputs: &[<AiReadmeWriter as ComputeLanguageModelRequests>::Seed],
) -> Vec<LanguageModelBatchAPIRequest>
fn compute_language_model_requests( &self, model: &LanguageModelType, inputs: &[<AiReadmeWriter as ComputeLanguageModelRequests>::Seed], ) -> Vec<LanguageModelBatchAPIRequest>
Source§impl ComputeSystemMessage for AiReadmeWriter
impl ComputeSystemMessage for AiReadmeWriter
Source§fn system_message() -> String
fn system_message() -> String
Source§impl FinishProcessingUncompletedBatches for AiReadmeWriter
impl FinishProcessingUncompletedBatches for AiReadmeWriter
type Error = LanguageModelBatchWorkflowError
Source§fn finish_processing_uncompleted_batches<'life0, 'life1, 'async_trait>(
&'life0 self,
expected_content_type: &'life1 ExpectedContentType,
) -> Pin<Box<dyn Future<Output = Result<(), <AiReadmeWriter as FinishProcessingUncompletedBatches>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
AiReadmeWriter: 'async_trait,
fn finish_processing_uncompleted_batches<'life0, 'life1, 'async_trait>(
&'life0 self,
expected_content_type: &'life1 ExpectedContentType,
) -> Pin<Box<dyn Future<Output = Result<(), <AiReadmeWriter as FinishProcessingUncompletedBatches>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
AiReadmeWriter: 'async_trait,
Source§impl GetBatchWorkspace<BatchWorkspaceError, <AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed> for AiReadmeWriter
impl GetBatchWorkspace<BatchWorkspaceError, <AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed> for AiReadmeWriter
fn workspace( &self, ) -> Arc<dyn FullBatchWorkspaceInterface<BatchWorkspaceError, <AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed, Item = Arc<dyn GetTargetPathForAIExpansion + Send + Sync>, Error = BatchWorkspaceError, Error = BatchWorkspaceError, Error = BatchWorkspaceError>>
Source§impl GetLanguageModelClient<LanguageModelBatchWorkflowError> for AiReadmeWriter
impl GetLanguageModelClient<LanguageModelBatchWorkflowError> for AiReadmeWriter
fn language_model_client( &self, ) -> Arc<dyn LanguageModelClientInterface<LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError, Error = LanguageModelBatchWorkflowError>>
Source§impl LanguageModelBatchWorkflow<LanguageModelBatchWorkflowError> for AiReadmeWriter
impl LanguageModelBatchWorkflow<LanguageModelBatchWorkflowError> for AiReadmeWriter
fn plant_seed_and_wait<'life0, 'life1, 'async_trait>(
&'life0 mut self,
input_tokens: &'life1 [<AiReadmeWriter as ComputeLanguageModelRequests>::Seed],
) -> Pin<Box<dyn Future<Output = Result<(), LanguageModelBatchWorkflowError>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
AiReadmeWriter: 'async_trait,
const REQUESTS_PER_BATCH: usize = 80usize
Source§fn execute_language_model_batch_workflow<'life0, 'life1, 'async_trait>(
&'life0 mut self,
model: LanguageModelType,
expected_content_type: ExpectedContentType,
input_tokens: &'life1 [Self::Seed],
) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: Send + 'async_trait,
fn execute_language_model_batch_workflow<'life0, 'life1, 'async_trait>(
&'life0 mut self,
model: LanguageModelType,
expected_content_type: ExpectedContentType,
input_tokens: &'life1 [Self::Seed],
) -> Pin<Box<dyn Future<Output = Result<(), E>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: Send + 'async_trait,
&[LanguageModelBatchAPIRequest] to process_batch_requests.Source§impl LanguageModelBatchWorkflowGatherResults for AiReadmeWriter
impl LanguageModelBatchWorkflowGatherResults for AiReadmeWriter
type Error = LanguageModelBatchWorkflowError
type Seed = <AiReadmeWriter as ComputeLanguageModelCoreQuery>::Seed
type Output = AiReadmeWriterDesiredOutput
Source§fn gather_results<'life0, 'life1, 'async_trait>(
&'life0 self,
seeds: &'life1 [<AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Seed],
) -> Pin<Box<dyn Future<Output = Result<Vec<(<AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Seed, <AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Output)>, <AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
AiReadmeWriter: 'async_trait,
fn gather_results<'life0, 'life1, 'async_trait>(
&'life0 self,
seeds: &'life1 [<AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Seed],
) -> Pin<Box<dyn Future<Output = Result<Vec<(<AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Seed, <AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Output)>, <AiReadmeWriter as LanguageModelBatchWorkflowGatherResults>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
AiReadmeWriter: 'async_trait,
(Seed, Output) pairs.Source§impl ProcessBatchRequests for AiReadmeWriter
impl ProcessBatchRequests for AiReadmeWriter
type Error = LanguageModelBatchWorkflowError
Source§fn process_batch_requests<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
batch_requests: &'life1 [LanguageModelBatchAPIRequest],
expected_content_type: &'life2 ExpectedContentType,
) -> Pin<Box<dyn Future<Output = Result<(), <AiReadmeWriter as ProcessBatchRequests>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
AiReadmeWriter: 'async_trait,
fn process_batch_requests<'life0, 'life1, 'life2, 'async_trait>(
&'life0 self,
batch_requests: &'life1 [LanguageModelBatchAPIRequest],
expected_content_type: &'life2 ExpectedContentType,
) -> Pin<Box<dyn Future<Output = Result<(), <AiReadmeWriter as ProcessBatchRequests>::Error>> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
'life2: 'async_trait,
AiReadmeWriter: 'async_trait,
impl Send for AiReadmeWriter
impl Sync for AiReadmeWriter
Auto Trait Implementations§
impl Freeze for AiReadmeWriter
impl !RefUnwindSafe for AiReadmeWriter
impl Unpin for AiReadmeWriter
impl !UnwindSafe for AiReadmeWriter
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
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> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
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>
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>
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 moreSource§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);