Struct SimulationAPI 

pub struct SimulationAPI { /* private fields */ }

Simulation-as-a-Service API

Implementations

impl SimulationAPI

pub fn new() -> Self

Create a new simulation API

pub fn with_storage(path: impl Into<PathBuf>) -> Self

Create API with persistent storage

pub fn submit_job(&self, job: SimulationJob) -> Uuid

Submit a simulation job

pub fn get_next_job(&self) -> Option<SimulationJob>

Get next job from queue

pub fn get_job(&self, id: &Uuid) -> Option<SimulationJob>

Get job status

pub fn cancel_job(&self, id: &Uuid) -> bool

Cancel a job

pub fn complete_job( &self, job_id: Uuid, metrics: SimulationMetrics, ) -> SimResult<Uuid>

Complete a job and store result

pub fn fail_job(&self, job_id: Uuid, error: impl Into<String>) -> SimResult<()>

Fail a job

pub fn get_result(&self, id: &Uuid) -> Option<SimulationResult>

Get simulation result

pub fn get_job_results(&self, job_id: &Uuid) -> Vec<SimulationResult>

Get all results for a job

pub fn compare_results(&self, result_ids: Vec<Uuid>) -> SimResult<Uuid>

Compare simulation results

pub fn get_comparison(&self, id: &Uuid) -> Option<SimulationComparison>

Get comparison

pub fn get_next_webhook(&self) -> Option<(String, WebhookNotification)>

Get next pending webhook

pub fn mark_webhook_delivered( &self, url: String, notification: WebhookNotification, )

Mark webhook as delivered

pub fn get_queue_stats(&self) -> QueueStats

Get queue statistics

Trait Implementations

impl Debug for SimulationAPI

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

Formats the value using the given formatter.

impl Default for SimulationAPI

fn default() -> Self

Returns the “default value” for a type.