Struct SpeciesReference

pub struct SpeciesReference {
    pub species: String,
    pub constant: bool,
    pub sbo_term: Option<String>,
    pub id: Option<String>,
    pub name: Option<String>,
    pub stoichiometry: Option<f64>,
}

Provide a way for reactions to define species as products and reactants.

Example

use quick_xml::de::from_str;
use rust_sbml::Reaction;

let reactions: Reaction = from_str(
"<reaction id='J1' reversible='false' fbc:lowerFluxBound='-20'>
        <listOfReactants>
            <speciesReference species='X0' stoichiometry='2' constant='true'/>
            <speciesReference species='X1' stoichiometry='1' constant='true'/>
</listOfReactants></reaction></listOfReactions></model>",
)
.unwrap();
println!("{:?}", reactions);
let mut specs_ref = reactions
    .list_of_reactants
    .species_references
    .iter();
assert!(specs_ref
    .any(|specref| specref.species == "X0"));
assert!(specs_ref
    .any(|specref| {println!("{:?}", specref); specref.stoichiometry.unwrap() as i32 == 1}));
assert!(specs_ref
    .all(|specref| specref.constant));

Fields

species: String

constant: bool

sbo_term: Option<String>

id: Option<String>

name: Option<String>

stoichiometry: Option<f64>

Trait Implementations

impl Clone for SpeciesReference

fn clone(&self) -> SpeciesReference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpeciesReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpeciesReference

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoPy<Py<PyAny>> for SpeciesReference

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

Performs the conversion.

impl PartialEq for SpeciesReference

fn eq(&self, other: &SpeciesReference) -> 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 PyClass for SpeciesReference

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 PyClassDescriptors<SpeciesReference> for PyClassImplCollector<SpeciesReference>

fn py_class_descriptors(self) -> &'static [PyMethodDefType]

impl PyClassImpl for SpeciesReference

const DOC: &'static str = /// Provide a way for reactions to define species as products and reactants.

Class doc string

const IS_GC: bool = false

#[pyclass(gc)]

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

type Layout = PyCell<SpeciesReference>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<SpeciesReference>

This handles following two situations:

fn for_each_method_def(visitor: &mut dyn FnMut(&[PyMethodDefType]))

fn get_new() -> Option<newfunc>

fn get_alloc() -> Option<allocfunc>

fn get_free() -> Option<freefunc>

fn get_call() -> Option<PyCFunctionWithKeywords>

fn for_each_proto_slot(visitor: &mut dyn FnMut(&[PyType_Slot]))

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

impl PyMethods<SpeciesReference> for PyClassImplCollector<SpeciesReference>

fn py_methods(self) -> &'static [PyMethodDefType]

impl PyTypeInfo for SpeciesReference

const NAME: &'static str = "SpeciesReference"

Class name.

const MODULE: Option<&'static str> = ::std::option::Option::None

Module name, if any.

type AsRefTarget = PyCell<SpeciesReference>

Utility type to make Py::as_ref work.

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

PyTypeObject instance for this type.

fn is_type_of(object: &PyAny) -> bool

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

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

impl Serialize for SpeciesReference

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 SpeciesReference