Struct RootBucket

pub struct RootBucket(pub Principal);

A root bucket.

Every token contract has a root bucket. This bucket is used for the main inserting transactions into history, and organizing fetching the bucket that corresponds to a given transaction.

A root bucket implements the same interface as Bucket, but with 3 additional methods.

Use RootBucket’s Into<Bucket> implementation to use a RootBucket as a Bucket.

Tuple Fields

0: Principal

Implementations

impl RootBucket

pub async fn get_bucket_for( &self, id: u64, ) -> Result<Bucket, (RejectionCode, String)>

Returns a bucket that be used to query for the given transaction ID.

pub async fn insert( &self, event: &IndefiniteEvent, ) -> Result<u64, (RejectionCode, String)>

Inserts the given transaction and returns it’s issued transaction ID.

pub async fn insert_many( &self, events: &[IndefiniteEvent], ) -> Result<u64, (RejectionCode, String)>

Inserts the given transactions.

pub async fn time(&self) -> Result<u64, (RejectionCode, String)>

The time on the canister.

The time can be used to check if this bucket is on the same subnet as the caller.

Trait Implementations

impl CandidType for RootBucket

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for RootBucket

fn clone(&self) -> RootBucket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for RootBucket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<RootBucket> for Bucket

fn from(root: RootBucket) -> Self

Converts to this type from the input type.

impl Serialize for RootBucket

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for RootBucket