wasmedge-sdk 0.7.1

//! Defines WasmEdge Statistics struct.

use crate::WasmEdgeResult;
use std::marker::PhantomData;
use wasmedge_sys as sys;

/// Used to collect statistics of the WasmEdge runtime, such as the count of instructions in execution.
#[derive(Debug)]
pub struct Statistics<'a> {
    pub(crate) inner: sys::Statistics,
    pub(crate) _marker: PhantomData<&'a ()>,
}
impl<'a> Statistics<'a> {
    /// Creates a new [Statistics].
    ///
    /// # Error
    ///
    /// If fail to create a [Statistics], then an error is returned.
    pub fn new() -> WasmEdgeResult<Self> {
        let inner = sys::Statistics::create()?;
        Ok(Self {
            inner,
            _marker: PhantomData,
        })
    }

    /// Returns the instruction count in execution.
    pub fn count_of_instr(&self) -> u64 {
        self.inner.instr_count()
    }

    /// Returns the instruction count per second in execution.
    ///
    /// # Notice
    ///
    /// For the following cases,
    /// - [Statistics] is not enabled, or
    /// - the total execution time is 0
    ///
    /// The instructions per second could be `NaN`, which represents `divided-by-zero`.
    /// Use the `is_nan` function of F64 to check the return value before use it,
    /// for example,
    ///
    /// ```
    /// use wasmedge_sdk::Statistics;
    ///
    /// // create a Statistics instance
    /// let stat = Statistics::new().expect("fail to create a Statistics");
    ///
    /// // check instruction count per second
    /// assert!(stat.instr_per_sec().is_nan());
    /// ```
    pub fn instr_per_sec(&self) -> f64 {
        self.inner.instr_per_sec()
    }

    /// Returns the total cost in execution.
    pub fn cost_in_total(&self) -> u64 {
        self.inner.cost_in_total()
    }

    /// Sets the cost of instructions.
    ///
    /// # Arguments
    ///
    /// - `cost_table` specifies the slice of cost table.
    pub fn set_cost_table(&mut self, cost_table: impl AsRef<[u64]>) {
        self.inner.set_cost_table(cost_table)
    }

    /// Sets the cost limit in execution.
    ///
    /// # Arguments
    ///
    /// - `limit` specifies the cost limit.
    pub fn set_cost_limit(&mut self, limit: u64) {
        self.inner.set_cost_limit(limit)
    }
}