Skip to main content

OutputListBuilder

Struct OutputListBuilder 

Source
pub struct OutputListBuilder<'a> {
    pub output_list: Vec<Output<'a>>,
}
Expand description

Builder pattern for constructing OutputList configurations.

Fields§

§output_list: Vec<Output<'a>>

Collection of Output configurations being built.

Implementations§

Source§

impl<'a> OutputListBuilder<'a>

Source

pub fn new() -> Self

Creates a new empty OutputListBuilder.

§Returns
  • OutputListBuilder - New instance with empty output list
Source

pub fn new_from(output_list: Vec<Output<'a>>) -> Self

Creates a new OutputListBuilder from existing outputs.

§Arguments
  • Vec<Output> - Collection of outputs to initialize with
§Returns
  • OutputListBuilder - New instance containing the specified outputs
Source

pub fn add(&mut self, output: Output<'a>) -> &mut Self

Adds an output to the list.

§Arguments
  • Output - The output configuration to add
§Returns
  • &mut Self - The builder for method chaining
Source

pub fn remove(&mut self, idx: usize) -> &mut Self

Removes an output item from the list at the specified index.

§Parameters
  • &mut self: A mutable reference to the current instance of OutputListBuilder.
  • idx: The index of the output item to be removed.
§Returns
  • &mut Self: A mutable reference to the current instance, allowing for method chaining.

If the index is out of bounds, the list remains unchanged.

Source

pub fn clear(&mut self)

Clears all output items from the output list.

§Parameters
  • &mut self: A mutable reference to the current instance of OutputListBuilder.
Source

pub fn run(&mut self) -> &mut Self

Runs all output items in the list, executing their output logic.

§Parameters
  • &mut self: A mutable reference to the current instance of OutputListBuilder.
§Returns
  • &mut Self: A mutable reference to the current instance, allowing for method chaining.

The method clones the current output list, clears the original list, and executes the output for each cloned item.

Source

pub fn query_idx(&self, idx: usize) -> Output<'_>

Queries the output item at the specified index.

§Parameters
  • &self: An immutable reference to the current instance of OutputListBuilder.
  • idx: The index of the output item to query.
§Returns
  • Output: The output item at the specified index, or a default output if the index is out of bounds.
Source

pub fn run_idx(&mut self, idx: usize) -> &mut Self

Runs the output item at the specified index.

§Parameters
  • &mut self: A mutable reference to the current instance of OutputListBuilder.
  • idx: The index of the output item to run.
§Returns
  • &mut Self: A mutable reference to the current instance, allowing for method chaining.

If the index is out of bounds, the list remains unchanged.

Trait Implementations§

Source§

impl<'a> Clone for OutputListBuilder<'a>

Source§

fn clone(&self) -> OutputListBuilder<'a>

Returns a duplicate 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<'a> Debug for OutputListBuilder<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for OutputListBuilder<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Hash for OutputListBuilder<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> Ord for OutputListBuilder<'a>

Source§

fn cmp(&self, other: &OutputListBuilder<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<'a> PartialEq for OutputListBuilder<'a>

Source§

fn eq(&self, other: &OutputListBuilder<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<'a> PartialOrd for OutputListBuilder<'a>

Source§

fn partial_cmp(&self, other: &OutputListBuilder<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<'a> Eq for OutputListBuilder<'a>

Source§

impl<'a> StructuralPartialEq for OutputListBuilder<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for OutputListBuilder<'a>

§

impl<'a> RefUnwindSafe for OutputListBuilder<'a>

§

impl<'a> Send for OutputListBuilder<'a>

§

impl<'a> Sync for OutputListBuilder<'a>

§

impl<'a> Unpin for OutputListBuilder<'a>

§

impl<'a> UnwindSafe for OutputListBuilder<'a>

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

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>,

Source§

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>,

Source§

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.