Struct ark_api_ffi::PodBool

#[repr(C)]
pub struct PodBool(_);

A version of bool that has the same layout as bool but is bytemuck::Pod.

In Rust, bool has a defined representation of being one byte with false being 0 and true being 1. However, it is not Pod because it is invalid to interpret a byte that contains any value other than 0 or 1 as a bool – doing so is undefined behavior.

Use this type to get around that limitation, as PodBool is valid for any value of u8, and its value is checked to be valid as a bool upon calling as_bool

Implementations

impl PodBool

pub fn as_bool(&self) -> bool

pub fn try_as_bool(&self) -> Result<bool, InvalidPodBool>

Trait Implementations

impl Clone for PodBool

fn clone(&self) -> PodBool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PodBool

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

Formats the value using the given formatter.

impl From<bool> for PodBool

fn from(v: bool) -> Self

Converts to this type from the input type.

impl PartialEq<PodBool> for PodBool

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

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

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

This method tests for !=.

impl Zeroable for PodBool

fn zeroed() -> Self

Calls zeroed.

impl Copy for PodBool

impl Eq for PodBool

impl Pod for PodBool

impl StructuralEq for PodBool

impl StructuralPartialEq for PodBool