Struct comfyui_api::comfy::PromptBuilder

source ·
pub struct PromptBuilder { /* private fields */ }
Expand description

A builder for creating a Prompt instance.

Implementations§

source§

impl PromptBuilder

source

pub fn new(base_prompt: &Prompt, output_node: Option<String>) -> Self

Constructs a new PromptBuilder instance.

§Arguments
  • base_prompt - The base Prompt to use as a starting point.
  • output_node - The output node to use when building the prompt.
§Returns

A new PromptBuilder instance.

source

pub fn prompt(self, value: String, node: Option<String>) -> Self

Sets the prompt.

§Arguments
  • value - The prompt value to use.
  • node - The node to set the prompt on.
source

pub fn negative_prompt(self, value: String, node: Option<String>) -> Self

Sets the negative prompt.

§Arguments
  • value - The negative prompt value to use.
  • node - The node to set the negative prompt on.
source

pub fn model(self, value: String, node: Option<String>) -> Self

Sets the model.

§Arguments
  • value - The model value to use.
  • node - The node to set the model on.
source

pub fn width(self, value: u32, node: Option<String>) -> Self

Sets the width.

§Arguments
  • value - The width value to use.
  • node - The node to set the width on.
source

pub fn height(self, value: u32, node: Option<String>) -> Self

Sets the height.

§Arguments
  • value - The height value to use.
  • node - The node to set the height on.
source

pub fn seed(self, value: i64, node: Option<String>) -> Self

Sets the seed.

§Arguments
  • value - The seed value to use.
  • node - The node to set the seed on.
source

pub fn build(self) -> Result<Prompt>

Builds a new Prompt instance based on the given parameters.

§Returns

A Result containing a new Prompt instance on success, or an error if a suitable output node could not be found.

Trait Implementations§

source§

impl Clone for PromptBuilder

source§

fn clone(&self) -> PromptBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PromptBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AsAny for T
where T: Any,

source§

fn as_any(&self) -> &(dyn Any + 'static)

Get a reference to dyn Any.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more