Struct Subscription 

pub struct Subscription {
    pub subscriber: Pubkey,
    pub predicate: Predicate,
    pub instructions: Vec<Instruction>,
    pub kind: SubscriptionKind,
    pub active_commits: RangeInclusive<Commmit>,
}

Subscription data stored by a user for a given topic. This is used to generate scheduled transactions to be run if the topic is triggered.

The instructions are a set of SVM instructions that are meant to be run when the subscription is triggered. The instruction array is converted to a SanitizedTransaction and executed in the VM.

Fields

subscriber: Pubkey

Subscriber key

predicate: Predicate

The predicate set by the subscriber to match the event

instructions: Vec<Instruction>

Instructions to be executed

kind: SubscriptionKind

Subscription kind

active_commits: RangeInclusive<Commmit>

Active commits for the subscription

Implementations

impl Subscription

pub fn new( subscriber: Pubkey, predicate: Predicate, instructions: Vec<Instruction>, kind: SubscriptionKind, active_commits: RangeInclusive<u64>, ) -> Self

Instantiate a new Subscription

Arguments

• subscriber - The public key of the subscriber
• predicate - The predicate to match the event
• instructions - A vector of instructions to be executed
• kind - The type of subscription (persistent or one-shot)
• active_commits - The range of active commits for the subscription

Returns

• Subscription - A new instance of Subscription

pub fn sanitize_instructions(&self) -> Result<(), SubscriptionError>

Sanitize a Subscription

Returns

Result<(), SubscriptionError> - Ok if the subscription is valid, Err otherwise

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Subscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Subscription

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

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 Subscription

impl StructuralPartialEq for Subscription