SimulationBuilder

Struct SimulationBuilder 

Source
pub struct SimulationBuilder {
    pub name: Option<String>,
    pub token: Option<Token>,
    pub description: Option<String>,
    pub options: Option<SimulationOptions>,
}
Expand description

Builder for creating a new simulation.

Fields§

§name: Option<String>

Name of the simulation. Required field.

§token: Option<Token>

Token used to run the simulation. Required field.

§description: Option<String>

Description of the simulation. Optional field.

§options: Option<SimulationOptions>

Input parameters for the simulation. Required field.

Implementations§

Source§

impl SimulationBuilder

Source

pub fn new() -> Self

Create a new simulation builder to configure the simulation.

§Returns

New simulation builder.

Source

pub fn name(self, name: String) -> Self

Set the name of the simulation.

§Arguments
  • name - Name of the simulation.
§Returns

The simulation builder.

Source

pub fn token(self, token: Token) -> Self

Set the token used to run the simulation.

§Arguments
  • token - Token used to run the simulation.
§Returns

The simulation builder.

Source

pub fn description(self, description: String) -> Self

Set the description of the simulation.

§Arguments
  • description - Description of the simulation.
§Returns

The simulation builder.

Source

pub fn options(self, options: SimulationOptions) -> Self

Set the input parameters for the simulation.

§Arguments
  • options - Input parameters for the simulation.
§Returns

The simulation builder.

Source

pub fn build(self) -> Result<Simulation, SimulationError>

Build the simulation.

§Returns

Built simulation or an error if required fields are missing.

Trait Implementations§

Source§

impl Debug for SimulationBuilder

Source§

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

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

impl Default for SimulationBuilder

Source§

fn default() -> SimulationBuilder

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

impl PartialEq for SimulationBuilder

Source§

fn eq(&self, other: &SimulationBuilder) -> 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 StructuralPartialEq for SimulationBuilder

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> 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> 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, 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.
Source§

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

Source§

fn vzip(self) -> V