Struct polymesh_api::polymesh::api::checkpoint::CallApi
source · [−]pub struct CallApi<'api> { /* private fields */ }Implementations
sourceimpl<'api> CallApi<'api>
impl<'api> CallApi<'api>
sourcepub fn create_checkpoint(&self, ticker: Ticker) -> Result<WrappedCall<'api>>
pub fn create_checkpoint(&self, ticker: Ticker) -> Result<WrappedCall<'api>>
Creates a single checkpoint at the current time.
Arguments
originis a signer that has permissions to act as an agent ofticker.tickerto create the checkpoint for.
Errors
UnauthorizedAgentif the DID oforiginisn’t a permissioned agent forticker.CounterOverflowif the total checkpoint counter would overflow.
sourcepub fn set_schedules_max_complexity(
&self,
max_complexity: u64
) -> Result<WrappedCall<'api>>
pub fn set_schedules_max_complexity(
&self,
max_complexity: u64
) -> Result<WrappedCall<'api>>
Sets the max complexity of a schedule set for an arbitrary ticker to max_complexity.
The new maximum is not enforced retroactively,
and only applies once new schedules are made.
Must be called as a PIP (requires “root”).
Arguments
originis the root origin.max_complexityallowed for an arbitrary ticker’s schedule set.
sourcepub fn create_schedule(
&self,
ticker: Ticker,
schedule: ScheduleSpec
) -> Result<WrappedCall<'api>>
pub fn create_schedule(
&self,
ticker: Ticker,
schedule: ScheduleSpec
) -> Result<WrappedCall<'api>>
Creates a schedule generating checkpoints in the future at either a fixed time or at intervals.
The schedule starts out with strong_ref_count(schedule_id) <- 0.
Arguments
originis a signer that has permissions to act as owner ofticker.tickerto create the schedule for.schedulethat will generate checkpoints.
Errors
UnauthorizedAgentif the DID oforiginisn’t a permissioned agent forticker.ScheduleDurationTooShortif the schedule duration is too short.InsufficientAccountBalanceif the protocol fee could not be charged.CounterOverflowif the schedule ID or total checkpoint counters would overflow.FailedToComputeNextCheckpointif the next checkpoint forscheduleis in the past.
Permissions
- Asset
sourcepub fn remove_schedule(
&self,
ticker: Ticker,
id: ScheduleId
) -> Result<WrappedCall<'api>>
pub fn remove_schedule(
&self,
ticker: Ticker,
id: ScheduleId
) -> Result<WrappedCall<'api>>
Removes the checkpoint schedule of an asset identified by id.
Arguments
originis a signer that has permissions to act as owner ofticker.tickerto remove the schedule from.idof the schedule, when it was created bycreated_schedule.
Errors
UnauthorizedAgentif the DID oforiginisn’t a permissioned agent forticker.NoCheckpointScheduleifiddoes not identify a schedule for thisticker.ScheduleNotRemovableifidexists but is not removable.
Permissions
- Asset
Trait Implementations
Auto Trait Implementations
impl<'api> !RefUnwindSafe for CallApi<'api>
impl<'api> Send for CallApi<'api>
impl<'api> Sync for CallApi<'api>
impl<'api> Unpin for CallApi<'api>
impl<'api> !UnwindSafe for CallApi<'api>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,
fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,
Convert from a value of T into an equivalent instance of Option<Self>. Read more
fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,
Consume self to return Some equivalent value of Option<T>. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>impl<R> Read for Box<R, Global> where
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
R: Read + ?Sized, impl<W> Write for Box<W, Global> where
W: Write + ?Sized, impl<I, A> Iterator for Box<I, A> where
I: Iterator + ?Sized,
A: Allocator, type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
F: Future + Unpin + ?Sized,
A: Allocator + 'static, type Output = <F as Future>::Output;
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s. Read more
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
sourcefn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,
Convert from a value of T into an equivalent instance of Self. Read more
sourcefn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,
Consume self to return an equivalent value of T. Read more
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,
fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
The counterpart to unchecked_from.
sourceimpl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,
impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,
sourcefn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
Consume self to return an equivalent value of T.
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more