Struct cap_sdk_core::RootBucket

source · [−]

pub struct RootBucket(pub Principal);

Expand description

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

source

impl RootBucket

source

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.

source

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

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

source

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

Inserts the given transactions.

source

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

source

fn idl_serialize<S>(&self, serializer: S) -> Result<(), S::Error> where
__S: Serializer,

fn ty() -> Type

source

impl Clone for RootBucket

source

fn clone(&self) -> RootBucket

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl From<RootBucket> for Bucket

source

fn from(root: RootBucket) -> Self

Converts to this type from the input type.

source

impl Serialize for RootBucket

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl Copy for RootBucket

Auto Trait Implementations

impl RefUnwindSafe for RootBucket

impl Send for RootBucket

impl Sync for RootBucket

impl Unpin for RootBucket

impl UnwindSafe for RootBucket

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

Struct cap_sdk_core::RootBucket

Tuple Fields

Implementations

impl RootBucket

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

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

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

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

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

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

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where __D: Deserializer<'de>,

impl From<RootBucket> for Bucket

fn from(root: RootBucket) -> Self

impl Serialize for RootBucket

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

impl Copy for RootBucket

Auto Trait Implementations

impl RefUnwindSafe for RootBucket

impl Send for RootBucket

impl Sync for RootBucket

impl Unpin for RootBucket

impl UnwindSafe for RootBucket

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

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

type Error = Infallible

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

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

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

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

impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,

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

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

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

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

fn idl_serialize<S>(&self, serializer: S) -> Result<(), S::Error> where
__S: Serializer,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,