Struct biodivine_sketchbook::sketchbook::model::_variable::Variable

pub struct Variable {
    name: String,
    annotation: String,
}

A type safe object for a Boolean variable of a ModelState.

Currently, it only stores the variable’s name and annotation.

Fields

name: String

annotation: String

Implementations

impl Variable

pub fn new_annotated( name_str: &str, annotation: &str, ) -> Result<Variable, String>

Create new Variable instance with an annotation.

pub fn new(name_str: &str) -> Result<Variable, String>

Create new Variable instance. Annotation is left empty.

pub fn get_name(&self) -> &str

Human-readable name of this variable.

pub fn get_annotation(&self) -> &str

Annotation of the variable.

pub fn set_name(&mut self, new_name: &str) -> Result<(), String>

Rename this variable.

pub fn set_annotation(&mut self, annotation: &str)

Change annotation of this variable.

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Variable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Variable

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

Formats the value using the given formatter.

impl Ord for Variable

fn cmp(&self, other: &Variable) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Variable

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

fn partial_cmp(&self, other: &Variable) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Variable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Variable

impl StructuralPartialEq for Variable