Struct comfyui_api::api::Api

pub struct Api { /* private fields */ }

Struct representing a connection to a ComfyUI API.

Implementations

impl Api

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

Returns a new Api instance with default settings.

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

where S: AsRef<str>,

Returns a new Api 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, ApiError>

where S: AsRef<str>,

Returns a new Api 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 fn prompt(&self) -> Result<PromptApi, ApiError>

Returns a new instance of PromptApi with the API’s cloned reqwest::Client and the URL for the prompt endpoint.

Errors

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

pub fn prompt_with_client(&self, client_id: Uuid) -> Result<PromptApi, ApiError>

Returns a new instance of PromptApi with the API’s cloned reqwest::Client and the URL for the prompt endpoint and the specified client id.

Arguments

• client_id - A uuid::Uuid representing the client id to use for the request.

Errors

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

pub fn history(&self) -> Result<HistoryApi, ApiError>

Returns a new instance of HistoryApi with the API’s cloned reqwest::Client and the URL for the history endpoint.

Errors

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

pub fn upload(&self) -> Result<UploadApi, ApiError>

Returns a new instance of UploadApi with the API’s cloned reqwest::Client and the URL for the view endpoint.

Errors

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

pub fn view(&self) -> Result<ViewApi, ApiError>

Returns a new instance of ViewApi with the API’s cloned reqwest::Client and the URL for the view endpoint.

Errors

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

pub fn websocket(&self) -> Result<WebsocketApi, ApiError>

Returns a new instance of WebsocketApi with the API’s cloned reqwest::Client and the URL for the ws endpoint.

Errors

• If the URL fails to parse, an error will be returned.
• On failure to set the ws:// scheme on the URL, an error will be returned.

pub fn websocket_with_client( &self, client_id: Uuid, ) -> Result<WebsocketApi, ApiError>

Returns a new instance of WebsocketApi with the API’s cloned reqwest::Client and the URL for the ws endpoint and the specified client id.

Arguments

• client_id - A uuid::Uuid representing the client id to use for the request.

Errors

• If the URL fails to parse, an error will be returned.
• On failure to set the ws:// scheme on the URL, an error will be returned.

Trait Implementations

impl Clone for Api

fn clone(&self) -> Api

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Api

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

Formats the value using the given formatter.

impl Default for Api

fn default() -> Self

Returns the “default value” for a type.