Struct Payload

#[repr(C)]
pub struct Payload { /* private fields */ }

A wrapper type for the payload hashmap.

Implementations

impl Payload

pub fn new() -> Self

Create a new empty Payload.

pub fn from<const N: usize>(arr: [(String, PayloadType); N]) -> Self

Create a Payload from an array of key-value pairs, specified as (PayloadKey, PayloadType) tuples.

pub fn insert(&mut self, key: String, value: PayloadType) -> Option<PayloadType>

Inserts a key-value pair into the Payload. If the Payload did not have this key present, then None is returned. If the Payload did have this key present, the value is updated, and the old value is returned. The key is not updated, though; this matters for types that can be == without being identical. See std::collections::HashMap documentation for more info.

pub fn try_insert(&mut self, key: String, value: PayloadType) -> ProgramResult

Tries to insert a key-value pair into a Payload. If this key is already in the Payload nothing is updated and an error is returned.

pub fn get(&self, key: &String) -> Option<&PayloadType>

Returns a reference to the value corresponding to the key.

pub fn get_pubkey(&self, key: &String) -> Option<&Pubkey>

Get a reference to the Pubkey associated with a key, if and only if the Payload value is the PayloadType::Pubkey variant. Returns None if the key is not present in the Payload or the value is a different PayloadType variant.

pub fn get_seeds(&self, key: &String) -> Option<&SeedsVec>

Get a reference to the SeedsVec associated with a key, if and only if the Payload value is the PayloadType::Seeds variant. Returns None if the key is not present in the Payload or the value is a different PayloadType variant.

pub fn get_merkle_proof(&self, key: &String) -> Option<&ProofInfo>

Get a reference to the ProofInfo associated with a key, if and only if the Payload value is the PayloadType::MerkleProof variant. Returns None if the key is not present in the Payload or the value is a different PayloadType variant.

pub fn get_amount(&self, key: &String) -> Option<u64>

Get the u64 associated with a key, if and only if the Payload value is the PayloadType::Number variant. Returns None if the key is not present in the Payload or the value is a different PayloadType variant.

Trait Implementations

impl BorshDeserialize for Payload

where HashMap<String, PayloadType>: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Payload

where HashMap<String, PayloadType>: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for Payload

fn clone(&self) -> Payload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Payload

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

Formats the value using the given formatter.

impl Default for Payload

fn default() -> Payload

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Payload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Payload

fn eq(&self, other: &Payload) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Payload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Payload

impl StructuralPartialEq for Payload