Struct pallet_scheduler::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn schedule( origin: OriginFor<T>, when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall> ) -> DispatchResult

Anonymously schedule a task.

pub fn cancel( origin: OriginFor<T>, when: BlockNumberFor<T>, index: u32 ) -> DispatchResult

Cancel an anonymously scheduled task.

pub fn schedule_named( origin: OriginFor<T>, id: TaskName, when: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall> ) -> DispatchResult

Schedule a named task.

pub fn cancel_named(origin: OriginFor<T>, id: TaskName) -> DispatchResult

Cancel a named scheduled task.

pub fn schedule_after( origin: OriginFor<T>, after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall> ) -> DispatchResult

Anonymously schedule a task after a delay.

pub fn schedule_named_after( origin: OriginFor<T>, id: TaskName, after: BlockNumberFor<T>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, call: Box<<T as Config>::RuntimeCall> ) -> DispatchResult

Schedule a named task after a delay.

pub fn set_retry( origin: OriginFor<T>, task: TaskAddress<BlockNumberFor<T>>, retries: u8, period: BlockNumberFor<T> ) -> DispatchResult

Set a retry configuration for a task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

pub fn set_retry_named( origin: OriginFor<T>, id: TaskName, retries: u8, period: BlockNumberFor<T> ) -> DispatchResult

Set a retry configuration for a named task so that, in case its scheduled run fails, it will be retried after period blocks, for a total amount of retries retries or until it succeeds.

Tasks which need to be scheduled for a retry are still subject to weight metering and agenda space, same as a regular task. If a periodic task fails, it will be scheduled normally while the task is retrying.

Tasks scheduled as a result of a retry for a periodic task are unnamed, non-periodic clones of the original task. Their retry configuration will be derived from the original task’s configuration, but will have a lower value for remaining than the original total_retries.

pub fn cancel_retry( origin: OriginFor<T>, task: TaskAddress<BlockNumberFor<T>> ) -> DispatchResult

Removes the retry configuration of a task.

pub fn cancel_retry_named(origin: OriginFor<T>, id: TaskName) -> DispatchResult

Cancel the retry configuration of a named task.

impl<T: Config> Pallet<T>

pub fn migrate_v1_to_v4() -> Weight

Migrate storage format from V1 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v2_to_v4() -> Weight

Migrate storage format from V2 to V4.

Returns the weight consumed by this migration.

pub fn migrate_v3_to_v4() -> Weight

Migrate storage format from V3 to V4.

Returns the weight consumed by this migration.

impl<T: Config> Pallet<T>

pub fn migrate_origin<OldOrigin: Into<T::PalletsOrigin> + Decode>()

Helper to migrate scheduler when the pallet origin type has changed.

Trait Implementations§

type Address = (<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, u32)

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

👎Deprecated: Use v3 instead. Will be removed after September 2024.

A means of expressing a call by the hash of its encoded data.

fn schedule( when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: CallOrHashOf<T> ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel((when, index): Self::Address) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule( address: Self::Address, when: DispatchTime<BlockNumberFor<T>> ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named. Read more

fn next_dispatch_time( (when, index): Self::Address ) -> Result<BlockNumberFor<T>, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task. Read more

type Address = (<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, u32)

An address which can be used for removing a scheduled task.

type Hasher = <T as Config>::Hashing

The hasher used in the runtime.

fn schedule( when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: BoundedCallOf<T> ) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel((when, index): Self::Address) -> Result<(), DispatchError>

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule( address: Self::Address, when: DispatchTime<BlockNumberFor<T>> ) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named. Read more

fn next_dispatch_time( (when, index): Self::Address ) -> Result<BlockNumberFor<T>, DispatchError>

Return the next dispatch time for a given task. Read more

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T> Benchmarking for Pallet<T>
where T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more

fn run_benchmark( extrinsic: &[u8], c: &[(BenchmarkParameter, u32)], whitelist: &[TrackedStorageKey], verify: bool, internal_repeats: u32 ) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

fn clone(&self) -> Self

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

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro. Read more

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead. Read more

fn on_initialize(now: BlockNumberFor<T>) -> Weight

Execute the scheduled calls

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]). Read more

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet. Read more

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block. Read more

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade. Read more

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade. Read more

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

type Address = (<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, u32)

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

type Hash = <T as Config>::Hash

👎Deprecated: Use v3 instead. Will be removed after September 2024.

A means of expressing a call by the hash of its encoded data.

fn schedule_named( id: Vec<u8>, when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: CallOrHashOf<T> ) -> Result<Self::Address, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel_named(id: Vec<u8>) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule_named( id: Vec<u8>, when: DispatchTime<BlockNumberFor<T>> ) -> Result<Self::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: Vec<u8>) -> Result<BlockNumberFor<T>, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task. Read more

type Address = (<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, u32)

An address which can be used for removing a scheduled task.

type Hasher = <T as Config>::Hashing

The hasher used in the runtime.

fn schedule_named( id: TaskName, when: DispatchTime<BlockNumberFor<T>>, maybe_periodic: Option<Period<BlockNumberFor<T>>>, priority: Priority, origin: T::PalletsOrigin, call: BoundedCallOf<T> ) -> Result<Self::Address, DispatchError>

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel_named(id: TaskName) -> Result<(), DispatchError>

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule_named( id: TaskName, when: DispatchTime<BlockNumberFor<T>> ) -> Result<Self::Address, DispatchError>

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. Read more

fn next_dispatch_time(id: TaskName) -> Result<BlockNumberFor<T>, DispatchError>

Return the next dispatch time for a given task. Read more

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced). Read more

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application. Read more

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration. Read more

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryDecodeEntireStorage for Pallet<T>

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect ) -> Result<(), TryRuntimeError>

Execute the state checks.

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

impl<T> Send for Pallet<T>
where T: Send,

impl<T> Sync for Pallet<T>
where T: Sync,

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

impl<T, BlockNumber, Call, RuntimeOrigin> Anon<BlockNumber, Call, RuntimeOrigin> for T
where T: Anon<BlockNumber, Call, RuntimeOrigin>,

type Address = <T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

fn schedule( when: DispatchTime<BlockNumber>, maybe_periodic: Option<(BlockNumber, u32)>, priority: u8, origin: RuntimeOrigin, call: Call ) -> Result<<T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel( address: <T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address ) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule( address: <T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address, when: DispatchTime<BlockNumber> ) -> Result<<T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block. For periodic tasks, this dispatch is guaranteed to succeed only before the initial execution; for others, use reschedule_named. Read more

fn next_dispatch_time( address: <T as Anon<BlockNumber, Call, RuntimeOrigin>>::Address ) -> Result<BlockNumber, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task. Read more

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for 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>,

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

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

fn __clone_box(&self, _: Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> IntoKey for T
where U: FromKey<T>,

fn into_key(self) -> U

impl<T> IsType<T> for T

fn from_ref(t: &T) -> &T

Cast reference.

fn into_ref(&self) -> &T

Cast reference.

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

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

Cast mutable reference.

impl<T, Outer> IsWrappedBy<Outer> for T
where Outer: AsRef<T> + AsMut<T> + From<T>, T: From<Outer>,

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

impl<T, BlockNumber, Call, RuntimeOrigin> Named<BlockNumber, Call, RuntimeOrigin> for T
where T: Named<BlockNumber, Call, RuntimeOrigin>,

type Address = <T as Named<BlockNumber, Call, RuntimeOrigin>>::Address

👎Deprecated: Use v3 instead. Will be removed after September 2024.

An address which can be used for removing a scheduled task.

fn schedule_named( id: Vec<u8>, when: DispatchTime<BlockNumber>, maybe_periodic: Option<(BlockNumber, u32)>, priority: u8, origin: RuntimeOrigin, call: Call ) -> Result<<T as Named<BlockNumber, Call, RuntimeOrigin>>::Address, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Schedule a dispatch to happen at the beginning of some block in the future. Read more

fn cancel_named(id: Vec<u8>) -> Result<(), ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Cancel a scheduled, named task. If periodic, then it will cancel all further instances of that, also. Read more

fn reschedule_named( id: Vec<u8>, when: DispatchTime<BlockNumber> ) -> Result<<T as Named<BlockNumber, Call, RuntimeOrigin>>::Address, DispatchError>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Reschedule a task. For one-off tasks, this dispatch is guaranteed to succeed only if it is executed before the currently scheduled block.

fn next_dispatch_time(id: Vec<u8>) -> Result<BlockNumber, ()>

👎Deprecated: Use v3 instead. Will be removed after September 2024.

Return the next dispatch time for a given task. Read more

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for 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

fn saturated_into<T>(self) -> T
where Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryIntoKey for T
where U: TryFromKey<T>,

type Error = >::Error

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

impl<S, T> UncheckedInto<T> for S
where T: UncheckedFrom<S>,

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S
where T: Bounded, S: TryInto<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>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> JsonSchemaMaybe for T

impl<T> MaybeDebug for T
where T: Debug,

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,

impl<T> MaybeRefUnwindSafe for T
where T: RefUnwindSafe,

impl<T> Member for T
where T: Send + Sync + Debug + Eq + PartialEq + Clone + 'static,