Struct relevant::Relevant

pub struct Relevant;

Values of this type can’t be automatically dropped. If struct or enum has field with type Relevant, it can’t be automatically dropped either. And so considered relevant too. User has to deconstruct such values and call Relevant::dispose. If relevant field is private it means that user has to move value into some public method. For example memory::Block should be returned to the MemoryAllocator it came from.

User of the engine won’t usually deal with real relevant types. More often user will face wrappers that has backdoor - some technique to dispose internal relevant fields with runtime cost. In debug mode such wrappers can put warnings in log. So that user will know they should be disposed manually.

Panics

Panics when dropped unless:

• log feature is enabled. It this case it emmits log::error!.
• std feature is enabled and thread is already in panicking state.

Implementations

impl Relevant

pub fn dispose(self)

Dispose this value.

Trait Implementations

impl Clone for Relevant

fn clone(&self) -> Relevant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Relevant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Relevant

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for Relevant

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for Relevant

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 Relevant

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Relevant> for Relevant

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Relevant> for Relevant

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

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

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

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

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

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

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

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

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

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

impl Serialize for Relevant

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 Relevant

impl StructuralEq for Relevant

impl StructuralPartialEq for Relevant