Struct zerovec::ule::OptionVarULE

#[repr(C, packed(1))]
pub struct OptionVarULE<U: VarULE + ?Sized>(PhantomData<U>, bool, [u8]);

A type allowing one to represent Option<U> for VarULE U types.

use zerovec::ule::OptionVarULE;
use zerovec::VarZeroVec;

let mut zv: VarZeroVec<OptionVarULE<str>> = VarZeroVec::new();

zv.make_mut().push(&None::<&str>);
zv.make_mut().push(&Some("hello"));
zv.make_mut().push(&Some("world"));
zv.make_mut().push(&None::<&str>);

assert_eq!(zv.get(0).unwrap().as_ref(), None);
assert_eq!(zv.get(1).unwrap().as_ref(), Some("hello"));

Tuple Fields

0: PhantomData<U>

1: bool

2: [u8]

Implementations

impl<U: VarULE + ?Sized> OptionVarULE<U>

pub fn as_ref(&self) -> Option<&U>

Obtain this as an Option<&U>

Trait Implementations

impl<U: VarULE + ?Sized + Debug> Debug for OptionVarULE<U>

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

Formats the value using the given formatter.

impl<T, U> EncodeAsVarULE<OptionVarULE<U>> for Option<T>

where T: EncodeAsVarULE<U>, U: VarULE + ?Sized,

fn encode_var_ule_as_slices<R>(&self, _: impl FnOnce(&[&[u8]]) -> R) -> R

Calls cb with a piecewise list of byte slices that when concatenated produce the memory pattern of the corresponding instance of T.

fn encode_var_ule_len(&self) -> usize

Return the length, in bytes, of the corresponding VarULE type

fn encode_var_ule_write(&self, dst: &mut [u8])

Write the corresponding VarULE type to the dst buffer. dst should be the size of Self::encode_var_ule_len()

impl<U: VarULE + ?Sized + Ord> Ord for OptionVarULE<U>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

impl<U: VarULE + ?Sized + PartialEq> PartialEq for OptionVarULE<U>

fn eq(&self, other: &Self) -> 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<U: VarULE + ?Sized + PartialOrd> PartialOrd for OptionVarULE<U>

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<U: VarULE + ?Sized> VarULE for OptionVarULE<U>

fn validate_byte_slice(slice: &[u8]) -> Result<(), ZeroVecError>

Validates a byte slice, &[u8].

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &Self

Takes a byte slice, &[u8], and return it as &Self with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success.

fn parse_byte_slice(bytes: &[u8]) -> Result<&Self, ZeroVecError>

Parses a byte slice, &[u8], and return it as &Self with the same lifetime.

fn as_byte_slice(&self) -> &[u8]

Given &Self, returns a &[u8] with the same lifetime.

fn to_boxed(&self) -> Box<Self>

Allocate on the heap as a Box<T>

impl<'a, T> ZeroMapKV<'a> for OptionVarULE<T>

where T: VarULE + ?Sized,

type Container = VarZeroVec<'a, OptionVarULE<T>>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = VarZeroSlice<OptionVarULE<T>>

type GetType = OptionVarULE<T>

The type produced by Container::get()

type OwnedType = Box<OptionVarULE<T>>

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl<U: VarULE + ?Sized + Eq> Eq for OptionVarULE<U>