Struct ImageRequest 

#[non_exhaustive]
pub struct ImageRequest {
    pub prompt: String,
    pub size: Option<String>,
    pub quality: Option<String>,
    pub name: Option<String>,
}

A request to generate an image.

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 draw.

size: Option<String>

Size, in the format of the provider (for example 1024x1024). Not sent when None.

quality: Option<String>

Quality, in the format of the provider (for example high). Not sent when None.

name: Option<String>

File name of the image, set as Media::name and so passed to the storage. Not sent to the provider. Without an extension, the one of the image type is added.

Implementations

impl ImageRequest

pub fn new(prompt: impl Into<String>) -> Self

Creates a request with a prompt.

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 ImageRequest

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 ImageRequest

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

Formats the value using the given formatter.

impl PartialEq for ImageRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImageRequest