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

A wrapper type for the payload hashmap.

Implementations§

source§

impl Payload

source

pub fn new() -> Self

Create a new empty Payload.

source

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.

source

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.

source

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.

source

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

Returns a reference to the value corresponding to the key.

source

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.

source

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.

source

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.

source

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§

source§

impl BorshDeserialize for Payloadwhere HashMap<String, PayloadType>: BorshDeserialize,

source§

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.
source§

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

Deserialize this instance from a slice of bytes.
source§

impl BorshSerialize for Payloadwhere HashMap<String, PayloadType>: BorshSerialize,

source§

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

source§

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

Serialize this instance into a vector of bytes.
source§

impl Clone for Payload

source§

fn clone(&self) -> Payload

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Payload

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Payload

source§

fn default() -> Payload

Returns the “default value” for a type. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl PartialEq<Payload> for Payload

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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.
source§

impl Serialize for Payload

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Payload

source§

impl StructuralEq for Payload

source§

impl StructuralPartialEq for Payload

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> AbiEnumVisitor for Twhere T: Serialize + ?Sized,

§

default fn visit_for_abi( &self, _digester: &mut AbiDigester ) -> Result<AbiDigester, DigestError>

§

impl<T> AbiEnumVisitor for Twhere T: Serialize + AbiExample + ?Sized,

§

default fn visit_for_abi( &self, digester: &mut AbiDigester ) -> Result<AbiDigester, DigestError>

§

impl<T> AbiExample for T

§

default fn example() -> T

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,