Struct comfyui_api::api::websocket::WebsocketApi

pub struct WebsocketApi { /* private fields */ }

Struct representing a connection to the ComfyUI API ws endpoint.

Implementations

impl WebsocketApi

pub fn new<S>(endpoint: S) -> Result<Self, WebSocketApiError>

where S: AsRef<str>,

Constructs a new WebsocketApi client with a given ComfyUI API endpoint.

Arguments

• endpoint - A str representation of the endpoint url.

Returns

A Result containing a new WebsocketApi instance on success, or an error if url parsing failed.

pub fn new_with_url(endpoint: Url) -> Self

Constructs a new WebsocketApi client with a given endpoint Url.

Arguments

• endpoint - A Url representing the endpoint url.

Returns

A new WebsocketApi instance.

pub async fn connect( &self, ) -> Result<impl FusedStream<Item = Result<PreviewOrUpdate, WebSocketApiError>>, WebSocketApiError>

Connects to the websocket endpoint and returns a stream of PreviewOrUpdate values.

Returns

A Stream of PreviewOrUpdate values. These are either Update values, which contain progress updates for a task, or Preview values, which contain a preview image.

pub async fn updates( &self, ) -> Result<impl FusedStream<Item = Result<Update, WebSocketApiError>>, WebSocketApiError>

Connects to the websocket endpoint and returns a stream of Update values.

Returns

A Stream of Update values. These contain progress updates for a task.

pub async fn previews( &self, ) -> Result<impl FusedStream<Item = Result<Preview, WebSocketApiError>>, WebSocketApiError>

Connects to the websocket endpoint and returns a stream of Preview values.

Returns

A Stream of Preview values. These contain preview images.

Trait Implementations

impl Clone for WebsocketApi

fn clone(&self) -> WebsocketApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketApi

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

Formats the value using the given formatter.