Struct spl_type_length_value::state::TlvStateMut

pub struct TlvStateMut<'data> { /* private fields */ }

Encapsulates mutable base state data (mint or account) with possible extensions

Implementations

impl<'data> TlvStateMut<'data>

pub fn unpack(data: &'data mut [u8]) -> Result<Self, ProgramError>

Unpacks TLV state data

Fails if no state is initialized or if data is too small

pub fn get_value_with_repetition_mut<V: SplDiscriminate + Pod>( &mut self, repetition_number: usize, ) -> Result<&mut V, ProgramError>

Unpack a portion of the TLV data as the desired type that allows modifying the type for the entry number specified

pub fn get_first_value_mut<V: SplDiscriminate + Pod>( &mut self, ) -> Result<&mut V, ProgramError>

Unpack a portion of the TLV data as the desired type that allows modifying the type for the first entry found

pub fn get_bytes_with_repetition_mut<V: SplDiscriminate>( &mut self, repetition_number: usize, ) -> Result<&mut [u8], ProgramError>

Unpack a portion of the TLV data as mutable bytes for the entry number specified

pub fn get_first_bytes_mut<V: SplDiscriminate>( &mut self, ) -> Result<&mut [u8], ProgramError>

Unpack a portion of the TLV data as mutable bytes for the first entry found

pub fn init_value<V: SplDiscriminate + Pod + Default>( &mut self, allow_repetition: bool, ) -> Result<(&mut V, usize), ProgramError>

Packs the default TLV data into the first open slot in the data buffer. Handles repetition based on the boolean arg provided:

• true: If extension is already found in the buffer, it returns an error.
• false: Will add a new entry to the next open slot.

pub fn pack_variable_len_value_with_repetition<V: SplDiscriminate + VariableLenPack>( &mut self, value: &V, repetition_number: usize, ) -> Result<(), ProgramError>

Packs a variable-length value into its appropriate data segment, where repeating discriminators are allowed

pub fn pack_first_variable_len_value<V: SplDiscriminate + VariableLenPack>( &mut self, value: &V, ) -> Result<(), ProgramError>

Packs a variable-length value into its appropriate data segment, where no repeating discriminators are allowed

pub fn alloc<V: SplDiscriminate>( &mut self, length: usize, allow_repetition: bool, ) -> Result<(&mut [u8], usize), ProgramError>

Allocate the given number of bytes for the given SplDiscriminate

pub fn alloc_and_pack_variable_len_entry<V: SplDiscriminate + VariableLenPack>( &mut self, value: &V, allow_repetition: bool, ) -> Result<usize, ProgramError>

Allocates and serializes a new TLV entry from a VariableLenPack type

pub fn realloc_with_repetition<V: SplDiscriminate>( &mut self, length: usize, repetition_number: usize, ) -> Result<&mut [u8], ProgramError>

Reallocate the given number of bytes for the given SplDiscriminate. If the new length is smaller, it will compact the rest of the buffer and zero out the difference at the end. If it’s larger, it will move the rest of the buffer data and zero out the new data.

pub fn realloc_first<V: SplDiscriminate>( &mut self, length: usize, ) -> Result<&mut [u8], ProgramError>

Reallocate the given number of bytes for the given SplDiscriminate, where no repeating discriminators are allowed

Trait Implementations

impl<'data> Debug for TlvStateMut<'data>

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

Formats the value using the given formatter.

impl<'data> PartialEq for TlvStateMut<'data>

fn eq(&self, other: &TlvStateMut<'data>) -> 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<'a> TlvState for TlvStateMut<'a>

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

Get the full buffer containing all TLV data

fn get_value_with_repetition<V: SplDiscriminate + Pod>( &self, repetition_number: usize, ) -> Result<&V, ProgramError>

Unpack a portion of the TLV data as the desired Pod type for the entry number specified

fn get_first_value<V: SplDiscriminate + Pod>(&self) -> Result<&V, ProgramError>

Unpack a portion of the TLV data as the desired Pod type for the first entry found

fn get_variable_len_value_with_repetition<V: SplDiscriminate + VariableLenPack>( &self, repetition_number: usize, ) -> Result<V, ProgramError>

Unpacks a portion of the TLV data as the desired variable-length type for the entry number specified

fn get_first_variable_len_value<V: SplDiscriminate + VariableLenPack>( &self, ) -> Result<V, ProgramError>

Unpacks a portion of the TLV data as the desired variable-length type for the first entry found

fn get_bytes_with_repetition<V: SplDiscriminate>( &self, repetition_number: usize, ) -> Result<&[u8], ProgramError>

Unpack a portion of the TLV data as bytes for the entry number specified

fn get_first_bytes<V: SplDiscriminate>(&self) -> Result<&[u8], ProgramError>

Unpack a portion of the TLV data as bytes for the first entry found

fn get_discriminators(&self) -> Result<Vec<ArrayDiscriminator>, ProgramError>

Iterates through the TLV entries, returning only the types

fn get_base_len() -> usize

Get the base size required for TLV data

impl<'data> StructuralPartialEq for TlvStateMut<'data>