Struct PodCOption

#[repr(C, packed(1))]
pub struct PodCOption<T>
where
    T: Pod + Default,
{ /* private fields */ }

COption stored as a Pod type

Implementations

impl<T> PodCOption<T>

where T: Pod + Default,

pub const NONE: [u8; 4] = _

Represents that no value is stored in the option, like Option::None

pub const SOME: [u8; 4] = _

Represents that some value is stored in the option, like Option::Some(v)

pub fn none() -> Self

Create a PodCOption equivalent of Option::None

This could be made const by using std::mem::zeroed, but that would require unsafe code, which is prohibited at the crate level.

pub const fn some(value: T) -> Self

Create a PodCOption equivalent of Option::Some(value)

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

Get the underlying value or another provided value if it isn’t set, equivalent of Option::unwrap_or

pub fn is_some(&self) -> bool

Checks to see if a value is set, equivalent of Option::is_some

pub fn is_none(&self) -> bool

Checks to see if no value is set, equivalent of Option::is_none

pub fn ok_or<E>(self, error: E) -> Result<T, E>

Converts the option into a Result, similar to Option::ok_or

Trait Implementations

impl<T> Clone for PodCOption<T>

where T: Pod + Default + Clone + Copy,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for PodCOption<T>

where T: Pod + Default + Debug + Copy,

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

Formats the value using the given formatter.

impl<T> Default for PodCOption<T>

where T: Pod + Default + Default,

fn default() -> PodCOption<T>

Returns the “default value” for a type.

impl<T: Pod + Default> From<COption<T>> for PodCOption<T>

fn from(opt: COption<T>) -> Self

Converts to this type from the input type.

impl<T> PartialEq for PodCOption<T>

where T: Pod + Default + PartialEq + Copy,

fn eq(&self, other: &PodCOption<T>) -> 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 TryFrom<PodCOption<Pubkey>> for OptionalNonZeroPubkey

type Error = ProgramError

The type returned in the event of a conversion error.

fn try_from(p: PodCOption<Pubkey>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> Zeroable for PodCOption<T>

where T: Pod + Default + Zeroable,

fn zeroed() -> Self

Calls zeroed.

impl<T> Copy for PodCOption<T>

where T: Pod + Default + Copy,

impl<T> Pod for PodCOption<T>

where T: Pod + Default + Pod,

impl<T> StructuralPartialEq for PodCOption<T>

where T: Pod + Default,