Struct NonOption

pub struct NonOption<T> { /* private fields */ }

An Option that is not really optional (but is still kinda). Start by creating the object by calling invalid (probably as a field in a struct constructor) and setting a value by calling “set” with a parameter as soon as possible. Attempting to use an invalid NonOption will cause a panic, so make absolutely sure you’ve set it with a value before calling “get_ref”, “get_mut” etc.

NonOptions are useful when you have objects that refernce each other but cannot have these references set during initalisation (becuse one of the objects does not yet exist).

Implementations

impl<T> NonOption<T>

pub fn new(value: T) -> Self

Constructs a new NonOption object with a value.

pub const fn invalid() -> Self

Constructs a new NonOption object with no value.

pub fn new_rfc(value: T) -> RefCell<Self>

pub fn invalid_rfc() -> RefCell<Self>

pub fn get_ref(&self) -> &T

pub fn get_mut(&mut self) -> &mut T

pub fn try_get_ref(&self) -> Option<&T>

pub fn try_get_mut(&mut self) -> Option<&mut T>

pub fn is_valid(&self) -> bool

pub fn is_invalid(&self) -> bool

pub fn unwrap_or(self, default: T) -> T

pub fn expect(self) -> T

pub fn set(&mut self, value: T)

Trait Implementations

impl<T> Clone for NonOption<T>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NonOption<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for NonOption<T>

fn default() -> Self

Returns the “default value” for a type.