Struct Pool 

pub struct Pool {
    pub max: u16,
    pub used: u16,
}

A count of limited uses: spell slots, Action Surge, Ki points, etc.

Fields

max: u16

used: u16

Implementations

impl Pool

pub fn new(max: u16) -> Self

A pool of max uses, none spent.

pub fn remaining(&self) -> u16

How many uses are left.

pub fn expend(&mut self, amount: u16) -> bool

Spends amount uses, or does nothing and returns false if there aren’t enough remaining.

pub fn restore(&mut self, amount: u16)

Regains up to amount uses (never beyond max).

pub fn reset(&mut self)

Regains every use.

pub fn is_valid(&self) -> bool

Whether no more are spent than there are.

Trait Implementations

impl Clone for Pool

fn clone(&self) -> Pool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for Pool

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for Pool

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

Formats the value using the given formatter.

impl Default for Pool

fn default() -> Pool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Pool

where Pool: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Pool

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for Pool

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Copy for Pool

impl Eq for Pool

impl StructuralPartialEq for Pool