Struct 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.

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 IntoPy<Py<PyAny>> for Compartment

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

Performs the conversion.

impl PartialEq for Compartment

fn eq(&self, other: &Compartment) -> 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 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 PyClassDescriptors<Compartment> for PyClassImplCollector<Compartment>

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

impl PyClassImpl for Compartment

const DOC: &'static str = /// A compartment in SBML represents a bounded space in which species are located.

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<Compartment>

Layout

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerStub<Compartment>

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<Compartment> for PyClassImplCollector<Compartment>

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

impl PyTypeInfo for Compartment

const NAME: &'static str = "Compartment"

Class name.

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

Module name, if any.

type AsRefTarget = PyCell<Compartment>

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 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