Enum red4ext_rs::types::Opt

pub enum Opt<T> {
    NonDefault(T),
    Default,
}

A convenience type to explicitly mark a function argument as opt T.

When left unspecified on Redscript side, it translates to its Default representation.

Variants

NonDefault(T)

Value is specified and guaranteed to be non-Default value.

Default

Default value.

Implementations

impl<T> Opt<T>

pub fn into_option(self) -> Option<T>

impl<T> Opt<T>

where T: Default,

pub fn unwrap_or_default(self) -> T

Trait Implementations

impl<T: Clone> Clone for Opt<T>

fn clone(&self) -> Opt<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Opt<T>

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

Formats the value using the given formatter.

impl<T> Default for Opt<T>

fn default() -> Opt<T>

Returns the “default value” for a type.

impl<T> Display for Opt<T>

where T: Display,

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

Formats the value using the given formatter.

impl<T> From<T> for Opt<T>

where T: Default + PartialEq,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<A: NativeRepr + Default + PartialEq> FromRepr for Opt<A>

type Repr = A

fn from_repr(repr: Self::Repr) -> Self

impl<A: NativeRepr + Default + PartialEq> IntoRepr for Opt<A>

type Repr = A

fn into_repr(self) -> Self::Repr

impl<T> Ord for Opt<T>

where T: Default + Ord,

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 + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq<T> for Opt<T>

where T: Default + PartialEq,

fn eq(&self, other: &T) -> 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<T> PartialEq for Opt<T>

where T: Default + PartialEq,

fn eq(&self, other: &Opt<T>) -> 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<T> PartialOrd<T> for Opt<T>

where T: Default + PartialOrd + Ord,

fn partial_cmp(&self, other: &T) -> 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<T> PartialOrd for Opt<T>

where T: Default + PartialOrd + Ord,

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

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<T: Copy> Copy for Opt<T>

impl<T> Eq for Opt<T>

where T: Eq + Default,