Struct Client 

pub struct Client { /* private fields */ }

Interface to the web UI.

Implementations

impl Client

pub async fn new(url: &str, authentication: Authentication<'_>) -> Result<Self>

Creates a new Client and authenticates to the web UI.

pub fn generate_from_text( &self, request: &TextToImageGenerationRequest, ) -> impl Future<Output = Result<GenerationResult>>

Generates an image from the provided request, which contains a prompt.

pub fn generate_from_image_and_text( &self, request: &ImageToImageGenerationRequest, ) -> impl Future<Output = Result<GenerationResult>>

Generates an image from the provided request, which contains both an image and a prompt.

pub async fn progress(&self) -> Result<GenerationProgress>

Retrieves the progress of the current generation.

Note that: - this does not disambiguate between generations (the WebUI does not expose details on its queue) - this will return 0% if there is no generation underway, which can be confusing after a generation finishes

pub async fn postprocess( &self, image: &DynamicImage, request: &PostprocessRequest, ) -> Result<DynamicImage>

Upscales the given image and applies additional (optional) post-processing.

pub async fn interrogate( &self, image: &DynamicImage, interrogator: Interrogator, ) -> Result<String>

Interrogates the given image with the interrogator to generate a caption.

pub async fn png_info(&self, image_bytes: &[u8]) -> Result<String>

Gets the PNG info for the image (assumed to be valid PNG)

pub async fn embeddings(&self) -> Result<Embeddings>

Get the embeddings

pub async fn options(&self) -> Result<Options>

Get the options

pub async fn samplers(&self) -> Result<Vec<Sampler>>

Get the samplers

pub async fn upscalers(&self) -> Result<Vec<Upscaler>>

Get the upscalers

pub async fn models(&self) -> Result<Vec<Model>>

Get the models

pub async fn hypernetworks(&self) -> Result<Vec<String>>

Get the hypernetworks

pub async fn face_restorers(&self) -> Result<Vec<String>>

Get the face restorers

pub async fn realesrgan_models(&self) -> Result<Vec<String>>

Get the real ESRGAN models

pub async fn prompt_styles(&self) -> Result<Vec<PromptStyle>>

Get the prompt styles

pub async fn artist_categories(&self) -> Result<Vec<String>>

Get the artist categories

pub async fn artists(&self) -> Result<Vec<Artist>>

Get the artists