Struct ImageGenerator 

pub struct ImageGenerator { /* private fields */ }

Generates and edits images with an ImageProvider.

It is cheap to clone: clones share the provider and the storage.

let generator = ImageGenerator::new("openai::gpt-image-1")?.with_size("1024x1024");
let response = generator.generate("A lighthouse at dawn").await?;
println!("{} image", response.image.content_type);

Implementations

impl ImageGenerator

pub fn new(model: &str) -> Result<Self, ImageError>

Creates a generator for a model, see provider::from_model: the provider comes from the name (openai::gpt-image-1) and its settings from environment variables.

pub fn from_provider(provider: impl ImageProvider) -> Self

Creates a generator with a provider you built, for example with the API key set in code.

pub fn with_storage(self, storage: impl MediaSave) -> Self

Saves every image in storage and sets ImageResponse::id.

pub fn with_size(self, size: impl Into<String>) -> Self

Size of every image that does not set its own, in the provider’s format (for example 1024x1024).

pub fn with_quality(self, quality: impl Into<String>) -> Self

Quality of every image that does not set its own, in the provider’s format (for example high).

pub fn model(&self) -> Option<&str>

Name of the model, if the provider has one.

pub fn size(&self) -> Option<&str>

The default size.

pub fn quality(&self) -> Option<&str>

The default quality.

pub fn supports_edit(&self) -> bool

Returns true when the provider can edit images.

pub async fn list_models(&self) -> Result<Vec<ImageModel>, ImageError>

Lists the image models of the provider, see provider::list_models.

pub async fn generate( &self, prompt: impl Into<String>, ) -> Result<ImageResponse, ImageError>

Generates an image from a prompt.

pub async fn generate_with( &self, request: ImageRequest, ) -> Result<ImageResponse, ImageError>

Generates an image from a full request. Unset size and quality take the defaults.

pub async fn edit( &self, prompt: impl Into<String>, images: Vec<Media>, ) -> Result<ImageResponse, ImageError>

Edits images following a prompt.

pub async fn edit_with( &self, request: ImageEditRequest, ) -> Result<ImageResponse, ImageError>

Edits images with a full request. Unset size and quality take the defaults.

Trait Implementations

impl Clone for ImageGenerator

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageGenerator

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

Formats the value using the given formatter.