Struct SimulationBuilder 

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

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

impl SimulationBuilder

pub fn new() -> Self

Create a new simulation builder to configure the simulation.

Returns

New simulation builder.

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

Set the name of the simulation.

Arguments

• name - Name of the simulation.

Returns

The simulation builder.

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.

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

Set the description of the simulation.

Arguments

• description - Description of the simulation.

Returns

The simulation builder.

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.

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

Build the simulation.

Returns

Built simulation or an error if required fields are missing.

Trait Implementations

impl Debug for SimulationBuilder

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

Formats the value using the given formatter.

impl Default for SimulationBuilder

fn default() -> SimulationBuilder

Returns the “default value” for a type.

impl PartialEq for SimulationBuilder

fn eq(&self, other: &SimulationBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for SimulationBuilder