Struct SyntheticInstrument_API

#[repr(C)]
pub struct SyntheticInstrument_API(/* private fields */);

C compatible Foreign Function Interface (FFI) for an underlying SyntheticInstrument.

This struct wraps SyntheticInstrument in a way that makes it compatible with C function calls, enabling interaction with SyntheticInstrument in a C environment.

It implements the Deref trait, allowing instances of SyntheticInstrument_API to be dereferenced to SyntheticInstrument, providing access to SyntheticInstruments’s methods without having to manually access the underlying instance.

Methods from Deref<Target = SyntheticInstrument>

pub fn is_valid_formula(&self, formula: &str) -> bool

pub fn change_formula(&mut self, formula: String) -> Result<()>

Errors

Returns an error if parsing the new formula fails.

pub fn calculate_from_map( &mut self, inputs: &HashMap<String, f64>, ) -> Result<Price>

Calculates the price of the synthetic instrument based on component input prices provided as a map.

Panics

Panics if a required component price is missing from the input map, or if setting the value in the evaluation context fails.

Errors

Returns an error if formula evaluation fails.

pub fn calculate(&mut self, inputs: &[f64]) -> Result<Price>

Calculates the price of the synthetic instrument based on the given component input prices provided as an array of f64 values.

Errors

Returns an error if the input length does not match or formula evaluation fails.

Trait Implementations

impl Debug for SyntheticInstrument_API

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

Formats the value using the given formatter.

impl Deref for SyntheticInstrument_API

type Target = SyntheticInstrument

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for SyntheticInstrument_API

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.