Skip to main content

OptionByte

Struct OptionByte 

Source
pub struct OptionByte<T: Copy> { /* private fields */ }
Expand description

Zero-copy tagged optional. See module docs for the layout and usage contract.

Implementations§

Source§

impl<T: Copy> OptionByte<T>

Source

pub const fn none(default_value: T) -> Self

Construct a None variant. Because the struct is #[repr(C)] with a Pod value field, the value payload must still be bitwise valid; the caller provides a default value that is ignored by OptionByte::get.

Source

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

Construct a Some(value) variant.

Source

pub const fn raw_tag(&self) -> u8

The tag byte as the sender encoded it. Callers should never inspect this directly; use OptionByte::get so the tag is validated first.

Source

pub fn get(&self) -> Result<Option<&T>, ProgramError>

Validate the tag byte and return the appropriate Rust Option.

Returns Err(ProgramError::InvalidInstructionData) when the tag is neither 0 nor 1. Any other byte indicates malformed instruction data and is the exact surface a Quasar OptionZc would flag in validate_zc.

Source

pub fn validate_tag(&self) -> ProgramResult

Validate-only: confirms the tag byte is 0 or 1. Useful for callers who want to reject malformed input early without taking a reference to the payload.

Trait Implementations§

Source§

impl<T: Clone + Copy> Clone for OptionByte<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy + Copy> Copy for OptionByte<T>

Auto Trait Implementations§

§

impl<T> Freeze for OptionByte<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for OptionByte<T>
where T: RefUnwindSafe,

§

impl<T> Send for OptionByte<T>
where T: Send,

§

impl<T> Sync for OptionByte<T>
where T: Sync,

§

impl<T> Unpin for OptionByte<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OptionByte<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for OptionByte<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.