Struct ImageEditBuilder 

pub struct ImageEditBuilder { /* private fields */ }

Builder describing an image edit request (/images/edits).

Implementations

impl ImageEditBuilder

pub fn new(image: impl AsRef<Path>, prompt: impl Into<String>) -> Self

Create a new edit request using a base image and prompt.

pub fn mask(self, mask: impl AsRef<Path>) -> Self

Supply a mask file that indicates editable regions.

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

Control the generated background (transparent, opaque, … as string).

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

Override the model (defaults to gpt-image-1).

pub fn n(self, n: i32) -> Self

Configure the number of images to generate (1-10).

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

Set the output size (e.g. 1024x1024).

pub fn response_format(self, format: impl Into<String>) -> Self

Choose the response format (url, b64_json).

pub fn output_format(self, format: impl Into<String>) -> Self

Choose the binary output format (png, jpeg, webp).

pub fn output_compression(self, compression: i32) -> Self

Configure output compression (0-100).

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

Attach an end-user identifier.

pub fn input_fidelity(self, fidelity: ImageInputFidelity) -> Self

Control fidelity for the input image (low/high).

pub fn stream(self, stream: bool) -> Self

Enable streaming responses for edits.

pub fn partial_images(self, value: i32) -> Self

Configure partial image count when streaming (0-3).

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

Provide quality hints (low, medium, high, …).

pub fn image(&self) -> &Path

Borrow the underlying image path.

pub fn prompt(&self) -> &str

Borrow the edit prompt.

Trait Implementations

impl Builder<ImageEditRequest> for ImageEditBuilder

fn build(self) -> Result<ImageEditRequest>

Build the final request type.

impl Clone for ImageEditBuilder

fn clone(&self) -> ImageEditBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageEditBuilder

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

Formats the value using the given formatter.