Enum SubscriberInstruction 

pub enum SubscriberInstruction {
    Subscribe {
        nonce: Nonce,
        handler: Subscription,
    },
    Unsubscribe {
        nonce: Nonce,
    },
    Update {
        nonce: Nonce,
        handler: Subscription,
    },
    Destroy {
        nonce: Nonce,
    },
}

Subscriber program instructions

Variants

Subscribe

Subscribe to events

Fields

nonce: Nonce

Nonce to differentiate handlers for the same topic

handler: Subscription

Subscription data

Unsubscribe

Delete subscription

Fields

nonce: Nonce

Nonce to differentiate handlers for the same topic/signer pair

Update

Update subscription

Fields

nonce: Nonce

Nonce used during subscription to differentiate handlers for the same topic/signer pair

handler: Subscription

New Subscription data

Destroy

Destroy subscription account.

The instruction transfers funds from the subscription account to the subscriber, marking the subscription account as removable.

This instruction does not emit any logs.

Fields

nonce: Nonce

Nonce to differentiate handlers for the same topic/signer pair

Implementations

impl SubscriberInstruction

pub fn subscribe_to( signer: Pubkey, nonce: Nonce, handler: Subscription, ) -> Instruction

Create a SubscriberInstruction::SubscribeToEvent Instruction

Account references

0. [SIGNER] Signer (subscriber) account
1. [WRITE] Subscription data account
2. [READONLY] System program account

Arguments

• signer - The public key of the subscriber
• nonce - The nonce to differentiate handlers for the same topic/signer pair
• handler - The Subscription data

Returns

• Instruction - An SVM instruction to be included in a transaction

pub fn unsubscribe_from(signer: Pubkey, nonce: Nonce) -> Instruction

Create a SubscriberInstruction::Unsubscribe Instruction

Account references

0. [SIGNER] Signer (subscriber) account
1. [WRITE] Subscription data account

Arguments

• signer - The public key of the subscriber
• nonce - The nonce to differentiate handlers for the same topic/signer pair

Returns

• Instruction - An SVM instruction to be included in a transaction

pub fn update( signer: Pubkey, nonce: Nonce, handler: Subscription, ) -> Instruction

Create a SubscriberInstruction::Update Instruction.

Account references

0. [SIGNER] Signer (subscriber) account
1. [WRITE] Subscription data account
2. [READONLY] System program account

Arguments

• signer - The public key of the subscriber
• nonce - The nonce set during subscription to differentiate handlers for the same topic/signer pair
• handler - The Subscription data

Returns

• Instruction - An SVM instruction to be included in a transaction

Trait Implementations

impl Clone for SubscriberInstruction

fn clone(&self) -> SubscriberInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriberInstruction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubscriberInstruction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SubscriberInstruction

fn eq(&self, other: &SubscriberInstruction) -> 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 SubscriberInstruction

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 SubscriberInstruction

impl StructuralPartialEq for SubscriberInstruction