Skip to main content

SysvarContext

Struct SysvarContext 

Source
pub struct SysvarContext { /* private fields */ }
Expand description

Combined sysvar context for a single instruction.

Parse all needed sysvars once at the top of your instruction handler, then pass this context to all validation functions.

let ctx = SysvarContext::new()
    .with_clock(&clock_account)?
    .with_rent(&rent_account)?;

ctx.clock()?.check_not_expired(deadline)?;
ctx.clock()?.check_slot_staleness(oracle_slot, 50)?;

Implementations§

Source§

impl SysvarContext

Source

pub const fn new() -> Self

Create an empty context.

Source

pub fn with_clock(self, clock_data: &[u8]) -> Result<Self, ProgramError>

Parse and cache the Clock sysvar.

Source

pub fn with_rent(self, rent_data: &[u8]) -> Result<Self, ProgramError>

Parse and cache the Rent sysvar.

Source

pub fn clock(&self) -> Result<&CachedClock, ProgramError>

Get the cached Clock. Returns error if not initialized.

Source

pub fn rent(&self) -> Result<&CachedRent, ProgramError>

Get the cached Rent. Returns error if not initialized.

Source

pub fn has_clock(&self) -> bool

Check if clock is available.

Source

pub fn has_rent(&self) -> bool

Check if rent is available.

Trait Implementations§

Source§

impl Default for SysvarContext

Source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.