Struct rust_sbml::Compartment

pub struct Compartment {
    pub units: Option<UnitSIdRef>,
    pub id: String,
    pub name: Option<String>,
    pub sbo_term: Option<String>,
    pub spatial_dimensions: Option<f64>,
    pub size: Option<f64>,
    pub constant: bool,
}

A compartment in SBML represents a bounded space in which species are located.

Example

use quick_xml::de::from_str;
use rust_sbml::Compartment;

let compartments: Vec<Compartment> = from_str(
    "<compartment id='Extracellular' spatialDimensions='3' size='1e-14' constant='true'/>
    <compartment id='PlasmaMembrane' spatialDimensions='2' size='1e-14' constant='true'/>
    <compartment id='Cytosol' spatialDimensions='3' size='1e-15' constant='true'/>"
)
.unwrap();
assert!(compartments.iter() .any(|c| c.spatial_dimensions.unwrap() as i32 == 2));
assert!(compartments.iter()
    .any(|c| c.id == "Cytosol"));
assert!(compartments.iter()
    .all(|c| c.constant));

Fields

units: Option<UnitSIdRef>

id: String

name: Option<String>

sbo_term: Option<String>

spatial_dimensions: Option<f64>

size: Option<f64>

constant: bool

Trait Implementations

impl Clone for Compartment

fn clone(&self) -> Compartment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Compartment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Compartment

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 Compartment

type Target = PyRef<'a, Compartment>

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

type Target = PyRefMut<'a, Compartment>

impl HasMethodsInventory for Compartment

type Methods = Pyo3MethodsInventoryForCompartment

impl IntoPy<Py<PyAny>> for Compartment

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

Performs the conversion.

impl PartialEq<Compartment> for Compartment

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

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

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

This method tests for !=.

impl PyClass for Compartment

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 Compartment

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 Compartment

type ThreadChecker = ThreadCheckerStub<Compartment>

impl PyProtoMethods for Compartment

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

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

impl PyTypeInfo for Compartment

type Type = Compartment

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 Compartment

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 Compartment