Enum ComfyEvent

pub enum ComfyEvent {
    Status {
        data: StatusEventData,
        sid: Option<String>,
    },
    Progress {
        data: ProgressEventData,
    },
    Executed {
        data: ExecutedEventData,
    },
    Executing {
        data: ExecutingEventData,
    },
    ExecutionStart {
        data: ExecutionStartEventData,
    },
    ExecutionError {
        data: ExecutionErrorEventData,
    },
    ExecutionCached {
        data: ExecutionCachedEventData,
    },
    ExecutionInterrupted {
        data: ExecutionInterruptedEventData,
    },
    ExecutionSuccess {
        data: ExecutionSuccessEventData,
    },
    Unknown(Value),
}

Represents events emitted by the ComfyUI service during workflow execution.

This enum encapsulates various event types that occur during the lifecycle of a workflow, from queuing to completion. Each variant contains specific data relevant to that event type. The Unknown variant captures any unrecognized events from the API.

Variants

Status

A status event containing queue and execution information.

Fields

data: StatusEventData

Data payload for the status event, including execution information.

sid: Option<String>

Optional session identifier associated with this event.

Progress

A progress event indicating current progress of an operation.

Fields

data: ProgressEventData

Data payload containing current and maximum progress values.

Executed

An event indicating that a node has completed execution along with its output data.

Fields

data: ExecutedEventData

Data payload containing node output information and associated images.

Executing

An event indicating that a node is currently executing.

Fields

data: ExecutingEventData

Data payload identifying the currently executing node.

ExecutionStart

An event signaling the start of execution for a prompt.

Fields

data: ExecutionStartEventData

Data payload containing prompt ID and timestamp information.

ExecutionError

An event signaling that an error occurred during execution.

Fields

data: ExecutionErrorEventData

Data payload containing detailed error information and context.

ExecutionCached

An event indicating that the execution results were retrieved from the cache.

Fields

data: ExecutionCachedEventData

Data payload containing information about which nodes were retrieved from cache.

ExecutionInterrupted

An event indicating that the execution was interrupted.

Fields

data: ExecutionInterruptedEventData

Data payload containing details about where and why the execution was interrupted.

ExecutionSuccess

An event indicating that the entire workflow has executed successfully.

Fields

data: ExecutionSuccessEventData

Data payload containing the prompt ID of the successfully executed workflow.

Unknown(Value)

An unknown event type that encapsulates raw JSON data for events not explicitly defined.

Trait Implementations

impl Debug for ComfyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ComfyEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ComfyEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.