Struct rust_sbml::Species

pub struct Species {
    pub id: String,
    pub name: Option<String>,
    pub meta_id: Option<String>,
    pub sbo_term: Option<String>,
    pub compartment: String,
    pub initial_concentration: Option<f64>,
    pub initial_amount: Option<f64>,
    pub substance_units: Option<UnitSIdRef>,
    pub has_only_substance_units: bool,
    pub boundary_condition: bool,
    pub constant: bool,
    pub conversion_factor: Option<String>,
}

A species in SBML refers to a pool of entities that

⁻ are considered indistinguishable from each other for the purposes of the model;

• may participate in reactions;
• are located in a specific compartment.

Example

use quick_xml::de::from_str;
use rust_sbml::Species;

let species: Vec<Species> = from_str(
    "<species id='Glucose' compartment='cell' initialConcentration='4'
    hasOnlySubstanceUnits='false' boundaryCondition='false' constant='false'/>"
)
.unwrap();
assert_eq!(species[0].id, "Glucose");
assert_eq!(species[0].compartment, "cell");
assert_eq!(species[0].initial_concentration.unwrap() as u8, 4);
assert!(!species[0].constant);
assert!(!species[0].boundary_condition);
assert!(!species[0].has_only_substance_units);

Fields

id: String

name: Option<String>

meta_id: Option<String>

sbo_term: Option<String>

compartment: String

initial_concentration: Option<f64>

initial_amount: Option<f64>

substance_units: Option<UnitSIdRef>

has_only_substance_units: bool

boundary_condition: bool

constant: bool

conversion_factor: Option<String>

Trait Implementations

impl Clone for Species

fn clone(&self) -> Species

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Species

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Species

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'a> ExtractExt<'a> for &'a Species

type Target = PyRef<'a, Species>

impl<'a> ExtractExt<'a> for &'a mut Species

type Target = PyRefMut<'a, Species>

impl HasMethodsInventory for Species

type Methods = Pyo3MethodsInventoryForSpecies

impl IntoPy<Py<PyAny>> for Species

fn into_py(self, py: Python<'_>) -> PyObject

Performs the conversion.

impl PartialEq<Species> for Species

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PyClass for Species

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

impl PyClassAlloc for Species

pub unsafe fn new(
    py: Python<'_>,
    subtype: *mut PyTypeObject
) -> *mut Self::Layout

Allocate the actual field for #[pyclass].

pub unsafe fn dealloc(py: Python<'_>, self_: *mut Self::Layout)

Deallocate #[pyclass] on the Python heap.

impl PyClassSend for Species

type ThreadChecker = ThreadCheckerStub<Species>

impl PyProtoMethods for Species

fn for_each_proto_slot<Visitor: FnMut(PyType_Slot)>(visitor: Visitor)

fn get_buffer() -> Option<&'static PyBufferProcs>

impl PyTypeInfo for Species

type Type = Species

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyCell<Self>

Layout

type BaseLayout = PyCellBase<PyAny>

Layout of Basetype.

type Initializer = PyClassInitializer<Self>

Initializer for layout

type AsRefTarget = PyCell<Self>

Utility type to make Py::as_ref work

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

PyTypeObject instance for this type.

pub fn is_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type or a subclass of this type.

pub fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Serialize for Species

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Species