JsonAccountsDeserializer

Struct JsonAccountsDeserializer 

Source
pub struct JsonAccountsDeserializer<'opts> {
    pub idl: Idl,
    pub provider: IdlProvider,
    pub account_deserializers: HashMap<DiscriminatorBytes, JsonIdlTypeDefinitionDeserializer<'opts>>,
    pub account_discriminators: HashMap<String, DiscriminatorBytes>,
    pub account_names: HashMap<DiscriminatorBytes, String>,
    pub type_map: JsonTypeDefinitionDeserializerMap<'opts>,
    pub serialization_opts: &'opts JsonSerializationOpts,
}
Expand description

Setup to deserialize accounts for a given program. The accounts are expected to have been serialized using the borsh format.

Uses deserializers defined inside [deserializer] modules under the hood in order to resolve the appropriate borsh deserializers for each field.

Fields§

§idl: Idl

The parsed Idl of the program

§provider: IdlProvider

The IdlProvider of the program

§account_deserializers: HashMap<DiscriminatorBytes, JsonIdlTypeDefinitionDeserializer<'opts>>

The deserializers for accounts of this program keyed by the discriminator of each account type.

§account_discriminators: HashMap<String, DiscriminatorBytes>

Allows looking up a discriminator for an account by name.

§account_names: HashMap<DiscriminatorBytes, String>

Allows looking up a account names by discriminator.

§type_map: JsonTypeDefinitionDeserializerMap<'opts>

Map of defined type deserializers. Defined types are be nested inside accounts.

§serialization_opts: &'opts JsonSerializationOpts

The JsonSerializationOpts specifying how specific data types should be deserialized.

Implementations§

Source§

impl<'opts> JsonAccountsDeserializer<'opts>

Source

pub fn try_from_idl( json: &str, provider: IdlProvider, serialization_opts: &'opts JsonSerializationOpts, ) -> ChainsawResult<Self>

Tries to create an [AccounbtDeserializer] by parsing the Idl. Fails if the IDL could not be parsed.

  • [json} the IDL definition in JSON format
  • [provider] the provider used to create the IDL
  • [serialization_opts] specifying how specific data types should be deserialized.
Source

pub fn from_idl( idl: Idl, provider: IdlProvider, serialization_opts: &'opts JsonSerializationOpts, ) -> Self

Creates an [AccounbtDeserializer] from the provided Idl Fails if the IDL could not be parsed.

  • [idl} the IDL definition
  • [provider] the provider used to create the IDL
  • [serialization_opts] specifying how specific data types should be deserialized.
Source

pub fn deserialize_account_data<W: Write>( &self, account_data: &mut &[u8], f: &mut W, ) -> ChainsawResult<()>

Deserializes an account from the provided data.

This is the common way of resolving an account json and using it to deserialize account data. It expects the first 8 bytes of data to hold the account discriminator as is the case for anchor accounts. For all other accounts use [deserialize_account_data_by_name] instead.

Source

pub fn deserialize_account_data_by_name<W: Write>( &self, account_data: &mut &[u8], account_name: &str, f: &mut W, ) -> ChainsawResult<()>

Deserializes an account from the provided data.

This method expects account data to not be prefixed with 8 bytes of discriminator data. Instead it derives that discriminator from the provided account name and then looks up the json.

Source

pub fn account_name(&self, discriminator: &DiscriminatorBytes) -> Option<&str>

Resolves the account name for the provided discriminator.

Auto Trait Implementations§

§

impl<'opts> Freeze for JsonAccountsDeserializer<'opts>

§

impl<'opts> RefUnwindSafe for JsonAccountsDeserializer<'opts>

§

impl<'opts> Send for JsonAccountsDeserializer<'opts>

§

impl<'opts> Sync for JsonAccountsDeserializer<'opts>

§

impl<'opts> Unpin for JsonAccountsDeserializer<'opts>

§

impl<'opts> UnwindSafe for JsonAccountsDeserializer<'opts>

Blanket Implementations§

Source§

impl<T> AbiExample for T

Source§

default fn example() -> T

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V