Struct Resource 

pub struct Resource<Content: ResourceType> { /* private fields */ }

Holds an arbitrary amount of a resource. A Resource object can be split into smaller parts, combined or Bundles can be extracted from them.

Implementations

impl<Content: ResourceType> Resource<Content>

pub const fn new_empty() -> Self

Creates a new empty Resource.

pub const fn amount(&self) -> u32

The current amount of the resource contained in this Resource.

pub const fn split(self, amount: u32) -> Result<(Self, Self), Self>

Splits the Resource into two smaller parts. If there are insufficient resources in the Resource, it returns an error with the original resource.

pub const fn split_off( &mut self, amount: u32, ) -> Result<Self, InsufficientResourceError<Content>>

Removes a specified amount of resources from this Resource and returns them as a new Resource. If there are insufficient resources in the Resource, it returns None.

pub const fn split_off_max(&mut self, amount: u32) -> Self

Removes up to the specified amount of resources from this Resource and returns them as a new Resource. If there are insufficient resources in the Resource, it returns all available resources.

pub const fn empty(&mut self) -> Self

Empties this Resource, returning all contained resources as a new Resource.

pub const fn empty_except(&mut self, amount: u32) -> Self

Empties this Resource except for the specified amount, returning the emptied resources as a new Resource.

pub const fn empty_into(&mut self, other: &mut Self)

Empties this Resource into another Resource, transferring all contained resources.

pub fn add(&mut self, other: impl Into<Self>)

Adds the entire contents of another resource container to this one.

pub const fn add_bundle<const AMOUNT: u32>( &mut self, bundle: Bundle<Content, AMOUNT>, )

Consumes a Bundle of the same resource type and adds the contained resources to this Resource.

pub const fn bundle<const AMOUNT: u32>( &mut self, ) -> Result<Bundle<Content, AMOUNT>, InsufficientResourceError<Content>>

Takes a specified amount of resources from this Resource and puts it into a Bundle.

Trait Implementations

impl<Content: ResourceType, const AMOUNT: u32> Add<Bundle<Content, AMOUNT>> for Resource<Content>

type Output = Resource<Content>

The resulting type after applying the + operator.

fn add(self, rhs: Bundle<Content, AMOUNT>) -> Self::Output

Performs the + operation.

impl<Content: ResourceType, const AMOUNT: u32> Add<Resource<Content>> for Bundle<Content, AMOUNT>

type Output = Resource<Content>

The resulting type after applying the + operator.

fn add(self, rhs: Resource<Content>) -> Self::Output

Performs the + operation.

impl<Content: ResourceType> Add for Resource<Content>

type Output = Resource<Content>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<Content: ResourceType, const AMOUNT: u32> AddAssign<Bundle<Content, AMOUNT>> for Resource<Content>

fn add_assign(&mut self, bundle: Bundle<Content, AMOUNT>)

Performs the += operation.

impl<Content: ResourceType> AddAssign for Resource<Content>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<Content: Debug + ResourceType> Debug for Resource<Content>

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

Formats the value using the given formatter.

impl<Content: ResourceType> Display for Resource<Content>

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

Formats the value using the given formatter.

impl<Content: ResourceType, const AMOUNT: u32> From<Bundle<Content, AMOUNT>> for Resource<Content>

fn from(bundle: Bundle<Content, AMOUNT>) -> Self

Converts to this type from the input type.

impl<Content: Ord + ResourceType> Ord for Resource<Content>

fn cmp(&self, other: &Resource<Content>) -> 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<Content: ResourceType> PartialEq<Resource<Content>> for u32

fn eq(&self, other: &Resource<Content>) -> 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<Content: ResourceType> PartialEq<u32> for Resource<Content>

fn eq(&self, other: &u32) -> 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<Content: PartialEq + ResourceType> PartialEq for Resource<Content>

fn eq(&self, other: &Resource<Content>) -> 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<Content: ResourceType> PartialOrd<Resource<Content>> for u32

fn partial_cmp(&self, other: &Resource<Content>) -> 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<Content: ResourceType> PartialOrd<u32> for Resource<Content>

fn partial_cmp(&self, other: &u32) -> 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<Content: PartialOrd + ResourceType> PartialOrd for Resource<Content>

fn partial_cmp(&self, other: &Resource<Content>) -> 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<Content: ResourceType> Sum for Resource<Content>

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<Content: Eq + ResourceType> Eq for Resource<Content>

impl<Content: ResourceType> StructuralPartialEq for Resource<Content>