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_mut<V: TlvDiscriminator + Pod>( &mut self ) -> Result<&mut V, ProgramError>

Unpack a portion of the TLV data as the desired type that allows modifying the type

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

Unpack a portion of the TLV data as mutable bytes

pub fn init_value<V: TlvDiscriminator + Pod + Default>( &mut self ) -> Result<&mut V, ProgramError>

Packs the default TLV data into the first open slot in the data buffer. If extension is already found in the buffer, it returns an error.

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

Allocate the given number of bytes for the given TlvDiscriminator

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

Reallocate the given number of bytes for the given TlvDiscriminator. 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.

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<TlvStateMut<'data>> 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<V: TlvDiscriminator + Pod>(&self) -> Result<&V, ProgramError>

Unpack a portion of the TLV data as the desired Pod type

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

Unpack a portion of the TLV data as bytes

fn get_discriminators(&self) -> Result<Vec<Discriminator>, 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>