Struct ImageEditRequest 

#[non_exhaustive]
pub struct ImageEditRequest {
    pub prompt: String,
    pub images: Vec<Media>,
    pub size: Option<String>,
    pub quality: Option<String>,
    pub name: Option<String>,
}

A request to edit images, or to make a new image from them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

prompt: String

What to change.

images: Vec<Media>

The images to edit.

size: Option<String>

Size, see ImageRequest::size.

quality: Option<String>

Quality, see ImageRequest::quality.

name: Option<String>

File name of the new image, see ImageRequest::name.

Implementations

impl ImageEditRequest

pub fn new(prompt: impl Into<String>, images: Vec<Media>) -> Self

Creates a request with a prompt and the images to edit.

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

Sets the size.

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

Sets the quality.

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

Sets the file name of the image, see ImageRequest::name.

Trait Implementations

impl Clone for ImageEditRequest

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 ImageEditRequest

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

Formats the value using the given formatter.

impl PartialEq for ImageEditRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImageEditRequest