Enum semeion::entity::lifespan::Lifespan

pub enum Lifespan {
    Ephemeral(Span),
    Immortal,
}

The lifespan of an entity.

Variants

Ephemeral(Span)

The Entity ages as the time goes on, and its lifespan decreases generation after generation.

Immortal

The Entity is not affected by the passing of time, and its lifespan does not decrease, but it can still be killed by other entities since its lifespan is defined and can be altered.

Implementations

impl Lifespan

pub fn with_span(span: impl Into<Span>) -> Self

Constructs an Ephemeral Lifespan with the given span value.

pub fn is_alive(&self) -> bool

Returns true only if there is lifespan left. It will always return true if immortal.

pub fn shorten(&mut self) -> &Self

Shorten the lifespan by a single unit of span, it has no effect if immortal. Returns the Lifespan left.

pub fn lengthen(&mut self) -> &Self

Lengthen the lifespan by a single unit of span, it has no effect if immortal. Returns the Lifespan left.

pub fn shorten_by(&mut self, amount: impl Into<Span>) -> &Self

Shorten the lifespan by the given amount of span, it has no effect if immortal. Returns the Lifespan left.

pub fn lengthen_by(&mut self, amount: impl Into<Span>) -> &Self

Lengthen the lifespan by the given amount of span, it has no effect if immortal. Returns the Lifespan left.

pub fn clear(&mut self)

Replaces the lifespan with a new empty one, by effectively representing the death of the entity. This method will have an effect also on an immortal lifespan.

pub fn span(self) -> Option<Span>

Gets the Span of the Lifespan if self is Ephemeral, otherwise returns None.

pub fn length(self) -> Option<u64>

Gets the length of the Lifespan if self is Ephemeral, otherwise returns None.

Trait Implementations

impl Clone for Lifespan

pub fn clone(&self) -> Lifespan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Lifespan

impl Debug for Lifespan

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

Formats the value using the given formatter.

impl Eq for Lifespan

impl Hash for Lifespan

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Lifespan

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Lifespan> for Lifespan

pub fn eq(&self, other: &Lifespan) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Lifespan) -> bool

This method tests for !=.

impl PartialOrd<Lifespan> for Lifespan

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for Lifespan

impl StructuralPartialEq for Lifespan