Struct comfyui_api::comfy::Comfy

pub struct Comfy { /* private fields */ }

Higher-level API for interacting with the ComfyUI API.

Implementations

impl Comfy

pub fn new() -> Result<Self, ComfyApiError>

Returns a new Comfy instance with default settings.

pub fn new_with_url<S>(url: S) -> Result<Self, ComfyApiError>

where S: AsRef<str>,

Returns a new Comfy instance with the given URL as a string value.

Arguments

• url - A string that specifies the ComfyUI API URL endpoint.

Errors

If the URL fails to parse, an error will be returned.

pub fn new_with_client_and_url<S>( client: Client, url: S, ) -> Result<Self, ComfyApiError>

where S: AsRef<str>,

Returns a new Comfy instance with the given reqwest::Client and URL as a string value.

Arguments

• client - An instance of reqwest::Client.
• url - A string that specifies the ComfyUI API URL endpoint.

Errors

If the URL fails to parse, an error will be returned.

pub async fn stream_prompt<'a>( &'a self, prompt: &Prompt, ) -> Result<impl FusedStream<Item = Result<NodeOutput, ComfyApiError>> + 'a, ComfyApiError>

Executes a prompt and returns a stream of generated images.

Arguments

• prompt - A Prompt to send to the ComfyUI API.

Returns

A Result containing a Stream of Result<NodeOutput> values on success, or an error if the request failed.

pub async fn execute_prompt( &self, prompt: &Prompt, ) -> Result<Vec<NodeOutput>, ComfyApiError>

Executes a prompt and returns the generated images.

Arguments

• prompt - A Prompt to send to the ComfyUI API.

Returns

A Result containing a Vec<NodeOutput> on success, or an error if the request failed.

pub async fn upload_file( &self, file: Vec<u8>, ) -> Result<ImageUpload, ComfyApiError>

Uploads a file to the ComfyUI API and returns information about the uploaded image.

Arguments

• file - A Vec<u8> containing the file data to upload.

Returns

A Result containing an ImageUpload on success, or an error if the request failed.

Trait Implementations

impl Clone for Comfy

fn clone(&self) -> Comfy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comfy

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

Formats the value using the given formatter.

impl Default for Comfy

fn default() -> Self

Returns the “default value” for a type.