Struct AssetRef 

pub struct AssetRef(Arc<Asset>);

A wrapper containing a reference-counted Asset.

AssetRef implements equality, ordering, and hashing using an AssetID, if available, but otherwise using a combination of other fields which should be unique at all the relevant points in the simulation.

Tuple Fields

0: Arc<Asset>

Implementations

impl AssetRef

pub fn make_mut(&mut self) -> &mut Asset

Make a mutable reference to the underlying Asset

fn get_asset_cmp(&self) -> AssetCmp<'_>

Get a representation of this AssetRef that can be used for comparisons

pub fn with_subset_of_tranches(self, new_num_tranches: u32) -> Self

Get an AssetRef representing a subset of this asset’s tranches.

If some of the asset’s tranches are mothballed, these are discarded before non-mothballed tranches. For example, if an asset has seven tranches of which four are mothballed and we are reducing the number of tranches to four, the new asset will have one mothballed tranche.

Panics

Panics if new_num_tranches is zero or exceeds the total capacity of this asset.

pub fn as_single_tranche(self) -> Self

Get an AssetRef representing a single tranche of this asset.

fn decommission(self, reason: &str)

Decommission this asset

fn with_decommission_mothballed( self, year: u32, mothball_years: u32, ) -> Option<Self>

Decommission any tranches that were mothballed at least mothball_years ago.

If the asset still has some tranches remaining, it is returned, else None.

pub fn with_mothballed_tranches( self, num_tranches: u32, year: Option<u32>, ) -> Self

Return a new AssetRef with the specified number of tranches mothballed.

If num_tranches equals the number of already mothballed tranches, the original asset is returned. If additional tranches may be mothballed, a value must be provided for year.

Panics

Panics if attempting to mothball more tranches than the asset represents or if attempting to change the number of mothballed tranches for a non-commissioned asset.

pub fn with_no_mothballed_tranches(self) -> Self

Returns a new AssetRef with no mothballed tranches.

If the asset has no mothballed tranches, the original asset is returned.

Trait Implementations

impl Clone for AssetRef

fn clone(&self) -> AssetRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AssetRef

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

Formats the value using the given formatter.

impl Deref for AssetRef

where Arc<Asset>: Deref,

type Target = <Arc<Asset> as Deref>::Target

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Eq for AssetRef

impl From<Arc<Asset>> for AssetRef

fn from(value: Arc<Asset>) -> Self

Converts to this type from the input type.

impl From<Asset> for AssetRef

fn from(value: Asset) -> Self

Converts to this type from the input type.

impl From<AssetRef> for Arc<Asset>

fn from(value: AssetRef) -> Self

Converts to this type from the input type.

impl From<UserAsset> for AssetRef

fn from(value: UserAsset) -> Self

Converts to this type from the input type.

impl Hash for AssetRef

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 AssetRef

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

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

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