Struct agnostic_orderbook::state::EventQueue

pub struct EventQueue<'a> { /* fields omitted */ }

The event queue account contains a serialized header and a circular buffer of serialized events.

This struct is used at runtime but doesn’t represent a serialized event queue

Implementations

impl<'a> EventQueue<'a>

pub fn new(
    header: EventQueueHeader,
    account: Rc<RefCell<&'a mut [u8]>>,
    callback_info_len: usize
) -> Self

Initialize a new EventQueue object.

Within a CPI context, the account parameter can be supplied through

use std::rc::Rc;
let a: AccountInfo;

let event_queue_header = EventQueueHeader::deserialize(&mut &a.data.borrow()[..EVENT_QUEUE_HEADER_LEN]).unwrap()
let event_queue = EventQueue::new(event_queue_header, Rc::clone(&a.data), callback_info_len);

impl<'a> EventQueue<'a>

pub fn peek_at(&self, index: u64) -> Option<Event>

Retrieves the event at position index in the queue.

pub fn read_register<T: BorshSerialize + BorshDeserialize>(
    &self
) -> Result<Register<T>, IoError>

This method is used to deserialize the event queue’s register

The nature of the serialized object should be deductible from caller context

pub fn iter<'b>(&'b self) -> QueueIterator<'a, 'b>

Returns an iterator over all the queue’s events

Trait Implementations

impl<'a, 'b> IntoIterator for &'b EventQueue<'a>

type Item = Event

The type of the elements being iterated over.

type IntoIter = QueueIterator<'a, 'b>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.