Struct solana_bucket_map::index_entry::PackedRefCount

#[repr(C)]
pub(crate) struct PackedRefCount {
    bytes: [u8; 8],
}

hold a big RefCount while leaving room for extra bits to be used for things like ‘Occupied’

Fields

bytes: [u8; 8]

Implementations

impl PackedRefCount

pub const fn new() -> Self

Returns an instance with zero initialized data.

impl PackedRefCount

pub const fn into_bytes(self) -> [u8; 8]

Returns the underlying bits.

Layout

The returned byte array is layed out in the same way as described here.

pub const fn from_bytes(bytes: [u8; 8]) -> Self

Converts the given bytes directly into the bitfield struct.

impl PackedRefCount

pub(crate) fn occupied(&self) -> <B1 as Specifier>::InOut

Returns the value of occupied. whether this entry in the data file is occupied or not

pub(crate) fn occupied_or_err( &self ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of occupied.

#Errors

If the returned value contains an invalid bit pattern for occupied. whether this entry in the data file is occupied or not

pub(crate) fn with_occupied(self, new_val: <B1 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of occupied set to the given value.

#Panics

If the given value is out of bounds for occupied. whether this entry in the data file is occupied or not

pub(crate) fn with_occupied_checked( self, new_val: <B1 as Specifier>::InOut ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of occupied set to the given value.

#Errors

If the given value is out of bounds for occupied. whether this entry in the data file is occupied or not

pub(crate) fn set_occupied(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of occupied to the given value.

#Panics

If the given value is out of bounds for occupied. whether this entry in the data file is occupied or not

pub(crate) fn set_occupied_checked( &mut self, new_val: <B1 as Specifier>::InOut ) -> Result<(), OutOfBounds>

Sets the value of occupied to the given value.

#Errors

If the given value is out of bounds for occupied. whether this entry in the data file is occupied or not

pub(crate) fn ref_count(&self) -> <B63 as Specifier>::InOut

Returns the value of ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

pub(crate) fn ref_count_or_err( &self ) -> Result<<B63 as Specifier>::InOut, InvalidBitPattern<<B63 as Specifier>::Bytes>>

Returns the value of ref_count.

#Errors

If the returned value contains an invalid bit pattern for ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

pub(crate) fn with_ref_count(self, new_val: <B63 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of ref_count set to the given value.

#Panics

If the given value is out of bounds for ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

pub(crate) fn with_ref_count_checked( self, new_val: <B63 as Specifier>::InOut ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of ref_count set to the given value.

#Errors

If the given value is out of bounds for ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

pub(crate) fn set_ref_count(&mut self, new_val: <B63 as Specifier>::InOut)

Sets the value of ref_count to the given value.

#Panics

If the given value is out of bounds for ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

pub(crate) fn set_ref_count_checked( &mut self, new_val: <B63 as Specifier>::InOut ) -> Result<(), OutOfBounds>

Sets the value of ref_count to the given value.

#Errors

If the given value is out of bounds for ref_count. ref_count of this entry. We don’t need any where near 63 bits for this value

Trait Implementations

impl CheckFillsUnalignedBits for PackedRefCount

type CheckType = [(); 1]

impl Clone for PackedRefCount

fn clone(&self) -> PackedRefCount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackedRefCount

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

Formats the value using the given formatter.

impl Default for PackedRefCount

fn default() -> PackedRefCount

Returns the “default value” for a type.

impl PartialEq<PackedRefCount> for PackedRefCount

fn eq(&self, other: &PackedRefCount) -> 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 Copy for PackedRefCount

impl Eq for PackedRefCount

impl StructuralEq for PackedRefCount

impl StructuralPartialEq for PackedRefCount