Enum AssetState

pub enum AssetState {
    Commissioned {
        id: AssetID,
        agent_id: AgentID,
    },
    Decommissioned {
        id: AssetID,
        agent_id: AgentID,
        decommission_year: u32,
    },
    Future {
        agent_id: AgentID,
    },
    Selected {
        agent_id: AgentID,
    },
    Candidate,
}

The state of an asset

New assets are created as either Future or Candidate assets. Future assets (which are specified in the input data) have a fixed capacity and capital costs already accounted for, whereas Candidate assets capital costs are not yet accounted for, and their capacity is determined by the investment algorithm.

Future and Candidate assets can be converted to Commissioned assets by calling commission_future or commission_candidate respectively.

Commissioned assets can be decommissioned by calling decommission.

Variants

Commissioned

The asset has been commissioned

Fields

id: AssetID

The ID of the asset

agent_id: AgentID

The ID of the agent that owns the asset

Decommissioned

The asset has been decommissioned

Fields

id: AssetID

The ID of the asset

agent_id: AgentID

The ID of the agent that owned the asset

decommission_year: u32

The year the asset was decommissioned

Future

The asset is planned for commissioning in the future

Fields

agent_id: AgentID

The ID of the agent that will own the asset

Selected

The asset has been selected for investment, but not yet confirmed

Fields

agent_id: AgentID

The ID of the agent that would own the asset

Candidate

The asset is a candidate for investment but has not yet been selected by an agent

Implementations

impl AssetState

pub fn name(&self) -> &str

Get the name of the asset state

Trait Implementations

impl Clone for AssetState

fn clone(&self) -> AssetState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AssetState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AssetState

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AssetState

fn cmp(&self, other: &AssetState) -> 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,

Restrict a value to a certain interval.

impl PartialEq for AssetState

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

fn partial_cmp(&self, other: &AssetState) -> 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 AssetState

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 AssetState

impl StructuralPartialEq for AssetState