Struct pallet_gear_program::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

type InstrumentedCodeStorage = CodeStorageWrap<T>

type InstrumentedLenStorage = CodeLenStorageWrap<T>

type MetadataStorage = MetadataStorageWrap<T>

type OriginalCodeStorage = OriginalCodeStorageWrap<T>

fn reset()

Attempt to remove all items from all the associated maps.

fn add_code(code_and_id: CodeAndId, metadata: CodeMetadata) -> Result<(), Error>

fn update_code(code_and_id: InstrumentedCodeAndId)

Update the corresponding code in the storage.

fn exists(code_id: CodeId) -> bool

fn remove_code(code_id: CodeId) -> bool

Returns true if the code associated with given id was removed.

fn get_code(code_id: CodeId) -> Option<InstrumentedCode>

fn get_code_len(code_id: CodeId) -> Option<u32>

fn get_original_code(code_id: CodeId) -> Option<Vec<u8>>

fn get_metadata(code_id: CodeId) -> Option<CodeMetadata>

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

type InCodeStorageVersion = StorageVersion

This type is generated by the pallet macro.

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.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

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

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]).

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

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

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

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.

fn integrity_test()

Check the integrity of this pallet’s configuration.

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

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> IterableMap<(ActorId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)> for Pallet<T>

type DrainIter = PrefixIterator<(ActorId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)>

Removal iterator type.

type Iter = PrefixIterator<(ActorId, Program<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number>)>

Getting iterator type.

fn drain() -> Self::DrainIter

Creates the removal iterator over map Items.

fn iter() -> Self::Iter

Creates the getting iterator over map Items.

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

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.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

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.

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

Tests for self and other values to be equal, and is used by ==.

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

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

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

type InternalError = Error<T>

type Error = DispatchError

type BlockNumber = <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number

type AccountId = <T as Config>::AccountId

type AllocationsMap = AllocationsStorageWrap<T>

type ProgramMap = ProgramStorageWrap<T>

type MemoryPageMap = MemoryPageStorageWrap<T>

fn pages_final_prefix() -> [u8; 32]

Final full prefix that prefixes all keys of memory pages.

fn reset()

Attempt to remove all items from all the associated maps.

fn add_program( program_id: ActorId, program: ActiveProgram<Self::BlockNumber>, ) -> Result<(), Self::Error>

Store a program to be associated with the given key program_id from the map.

fn get_program(program_id: ActorId) -> Option<Program<Self::BlockNumber>>

Load the program associated with the given key program_id from the map.

fn program_exists(program_id: ActorId) -> bool

Does the program (explicitly) exist in storage?

fn update_active_program<F, ReturnType>( program_id: ActorId, update_action: F, ) -> Result<ReturnType, Self::Error>

where F: FnOnce(&mut ActiveProgram<Self::BlockNumber>) -> ReturnType,

Update the active program under the given key program_id.

fn remove_data_for_pages( program_id: ActorId, memory_infix: MemoryInfix, pages: impl Iterator<Item = Page<gear_core::::pages::GearPage::{constant#0}>>, )

fn allocations( program_id: ActorId, ) -> Option<IntervalsTree<Page<gear_core::::pages::WasmPage::{constant#0}>>>

fn set_allocations( program_id: ActorId, allocations: IntervalsTree<Page<gear_core::::pages::WasmPage::{constant#0}>>, )

fn clear_allocations(program_id: ActorId)

fn memory_infix(program_id: ActorId) -> Option<MemoryInfix>

fn update_program_if_active<F, ReturnType>( program_id: ActorId, update_action: F, ) -> Result<ReturnType, Self::Error>

where F: FnOnce(&mut Program<Self::BlockNumber>, Self::BlockNumber) -> ReturnType,

Update the program under the given key program_id only if the stored program is an active one.

fn get_program_pages_data( program_id: ActorId, memory_infix: MemoryInfix, ) -> Result<BTreeMap<Page<gear_core::::pages::GearPage::{constant#0}>, PageBuf>, Self::Error>

Return data buffer for each memory page, which has data.

fn set_program_page_data( program_id: ActorId, memory_infix: MemoryInfix, page: Page<gear_core::::pages::GearPage::{constant#0}>, page_buf: PageBuf, )

Store a memory page buffer to be associated with the given keys program_id, memory_infix and page from the map.

fn remove_program_page_data( program_id: ActorId, memory_infix: MemoryInfix, page_num: Page<gear_core::::pages::GearPage::{constant#0}>, )

Remove a memory page buffer under the given keys program_id, memory_infix and page.

fn clear_program_memory(program_id: ActorId, memory_infix: MemoryInfix)

Remove all memory page buffers under the given keys program_id and memory_infix.

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

fn storage_info() -> Vec<StorageInfo>

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>