Trait UpdateReadmeFiles

pub trait UpdateReadmeFiles {
    type Error;

    // Required method
    fn update_readme_files<'life0, 'async_trait>(
        handle: Arc<Mutex<Self>>,
        plant: bool,
        force: bool,
        config: &'life0 ReadmeWriterConfig,
    ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>
       where 'life0: 'async_trait,
             Self: 'async_trait;
}

Required Associated Types

type Error

Required Methods

fn update_readme_files<'life0, 'async_trait>( handle: Arc<Mutex<Self>>, plant: bool, force: bool, config: &'life0 ReadmeWriterConfig, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Orchestrates the steps to generate queries, call the AI, and update README(s). The force parameter means: if false, skip crates/workspaces that already have a README. The config carries user preferences (docs/fn-bodies/test-items/etc.) for readme generation.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl UpdateReadmeFiles for CrateHandle

type Error = AiReadmeWriterError

impl<H> UpdateReadmeFiles for Workspace<PathBuf, H>

where H: ReadmeWritingCrateHandle<PathBuf>,

type Error = AiReadmeWriterError