Struct Txt2ImgRequest 

pub struct Txt2ImgRequest {
    pub positive_prompt: String,
    pub negative_prompt: String,
    pub checkpoint: String,
    pub width: u32,
    pub height: u32,
    pub steps: u32,
    pub cfg_scale: f64,
    pub sampler: String,
    pub scheduler: String,
    pub seed: i64,
    pub batch_size: u32,
    pub filename_prefix: String,
}

Builder for a txt2img ComfyUI workflow.

Constructs a standard 7-node pipeline: CheckpointLoader → CLIP encoders → KSampler → VAEDecode → SaveImage.

Example

use comfyui_rs::Txt2ImgRequest;

let (workflow, seed) = Txt2ImgRequest::new("a cat in space", "dreamshaper_8.safetensors")
    .negative("lowres, blurry")
    .size(512, 768)
    .steps(25)
    .cfg_scale(7.5)
    .build();

assert!(seed >= 0);
assert!(workflow.get("1").is_some()); // CheckpointLoader node

Fields

positive_prompt: String

negative_prompt: String

checkpoint: String

width: u32

height: u32

steps: u32

cfg_scale: f64

sampler: String

scheduler: String

seed: i64

batch_size: u32

filename_prefix: String

Implementations

impl Txt2ImgRequest

pub fn new(prompt: impl Into<String>, checkpoint: impl Into<String>) -> Self

Create a new request with a prompt and checkpoint. Uses sensible defaults for all other parameters (512x768, 25 steps, cfg 7.5, dpmpp_2m/karras).

pub fn negative(self, prompt: impl Into<String>) -> Self

Set the negative prompt.

pub fn size(self, width: u32, height: u32) -> Self

Set output dimensions.

pub fn steps(self, steps: u32) -> Self

Set the number of sampling steps.

pub fn cfg_scale(self, cfg: f64) -> Self

Set the classifier-free guidance scale.

pub fn sampler(self, sampler: impl Into<String>) -> Self

Set the sampler algorithm (e.g. “euler”, “dpmpp_2m”, “dpmpp_sde”).

pub fn scheduler(self, scheduler: impl Into<String>) -> Self

Set the noise scheduler (e.g. “normal”, “karras”, “exponential”).

pub fn seed(self, seed: i64) -> Self

Set a specific seed. Use -1 (the default) for random.

pub fn batch_size(self, size: u32) -> Self

Set the batch size (number of images per generation).

pub fn filename_prefix(self, prefix: impl Into<String>) -> Self

Set the output filename prefix in ComfyUI.

pub fn build(&self) -> (Value, i64)

Build the ComfyUI workflow JSON and resolve the seed.

Returns (workflow_json, actual_seed). When seed is -1, a random seed is generated and returned so it can be stored with the image.

Trait Implementations

impl Clone for Txt2ImgRequest

fn clone(&self) -> Txt2ImgRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Txt2ImgRequest

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

Formats the value using the given formatter.