Struct pallet_gear::pallet::Pallet
source · pub struct Pallet<T>(/* private fields */);
Expand description
The Pallet
struct, the main type that implements traits and standalone
functions within the pallet.
Implementations§
source§impl<T: Config> Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Pallet<T>where
T::AccountId: Origin,
pub fn spend_gas( to: Option<<T as Config>::AccountId>, id: impl Into<GasNodeIdOf<T>>, amount: GasBalanceOf<T>, )
source§impl<T: Config> Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Pallet<T>where
T::AccountId: Origin,
sourcepub fn set_block_number(bn: BlockNumberFor<T>)
pub fn set_block_number(bn: BlockNumberFor<T>)
Set gear block number.
For tests only.
pub fn read_state_using_wasm( program_id: H256, payload: Vec<u8>, fn_name: Vec<u8>, wasm: Vec<u8>, argument: Option<Vec<u8>>, gas_allowance: Option<u64>, ) -> Result<Vec<u8>, Vec<u8>>
pub fn read_state( program_id: H256, payload: Vec<u8>, gas_allowance: Option<u64>, ) -> Result<Vec<u8>, Vec<u8>>
pub fn read_metahash( program_id: H256, gas_allowance: Option<u64>, ) -> Result<H256, Vec<u8>>
pub fn calculate_gas_info( source: H256, kind: HandleKind, payload: Vec<u8>, value: u128, allow_other_panics: bool, initial_gas: Option<u64>, gas_allowance: Option<u64>, ) -> Result<GasInfo, Vec<u8>>
pub fn calculate_reply_for_handle( origin: H256, destination: H256, payload: Vec<u8>, gas_limit: u64, value: u128, allowance_multiplier: u64, ) -> Result<ReplyInfo, Vec<u8>>
pub fn run_with_ext_copy<R, F: FnOnce() -> R>(f: F) -> R
sourcepub fn is_initialized(program_id: ProgramId) -> bool
pub fn is_initialized(program_id: ProgramId) -> bool
Returns true if a program has been successfully initialized
sourcepub fn is_active(
builtins: &impl BuiltinDispatcher,
program_id: ProgramId,
) -> bool
pub fn is_active( builtins: &impl BuiltinDispatcher, program_id: ProgramId, ) -> bool
Returns true if program_id
is that of a in active status or the builtin actor.
sourcepub fn is_terminated(program_id: ProgramId) -> bool
pub fn is_terminated(program_id: ProgramId) -> bool
Returns true if id is a program and the program has terminated status.
sourcepub fn is_exited(program_id: ProgramId) -> bool
pub fn is_exited(program_id: ProgramId) -> bool
Returns true if id is a program and the program has exited status.
sourcepub fn program_exists(
builtins: &impl BuiltinDispatcher,
program_id: ProgramId,
) -> bool
pub fn program_exists( builtins: &impl BuiltinDispatcher, program_id: ProgramId, ) -> bool
Returns true if there is a program with the specified program_id`` (it may be paused) or this
program_id` belongs to the built-in actor.
sourcepub fn first_inheritor_of(program_id: ProgramId) -> Option<ProgramId>
pub fn first_inheritor_of(program_id: ProgramId) -> Option<ProgramId>
Returns inheritor of an exited/terminated program.
sourcepub fn next_message_id(user_id: H256) -> MessageId
pub fn next_message_id(user_id: H256) -> MessageId
Returns MessageId for newly created user message.
sourcepub fn process_tasks(ext_manager: &mut ExtManager<T>)
pub fn process_tasks(ext_manager: &mut ExtManager<T>)
Delayed tasks processing.
pub fn run_call(max_gas: Option<GasBalanceOf<T>>) -> Call<T>
source§impl<T: Config> Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Pallet<T>where
T::AccountId: Origin,
sourcepub fn upload_code(
origin: OriginFor<T>,
code: Vec<u8>,
) -> DispatchResultWithPostInfo
pub fn upload_code( origin: OriginFor<T>, code: Vec<u8>, ) -> DispatchResultWithPostInfo
Saves program code
in storage.
The extrinsic was created to provide deploy program from program functionality. Anyone who wants to define a “factory” logic in program should first store the code and metadata for the “child” program in storage. So the code for the child will be initialized by program initialization request only if it exists in storage.
More precisely, the code and its metadata are actually saved in the storage under the hash of the code
. The code hash is computed
as Blake256 hash. At the time of the call the code
hash should not be in the storage. If it was stored previously, call will end up
with an CodeAlreadyExists
error. In this case user can be sure, that he can actually use the hash of his program’s code bytes to define
“program factory” logic in his program.
Parameters
code
: wasm code of a program as a byte vector.
Emits the following events:
SavedCode(H256)
- when the code is saved in storage.
sourcepub fn upload_program(
origin: OriginFor<T>,
code: Vec<u8>,
salt: Vec<u8>,
init_payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
) -> DispatchResultWithPostInfo
pub fn upload_program( origin: OriginFor<T>, code: Vec<u8>, salt: Vec<u8>, init_payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, ) -> DispatchResultWithPostInfo
Creates program initialization request (message), that is scheduled to be run in the same block.
There are no guarantees that initialization message will be run in the same block due to block gas limit restrictions. For example, when it will be the message’s turn, required gas limit for it could be more than remaining block gas limit. Therefore, the message processing will be postponed until the next block.
ProgramId
is computed as Blake256 hash of concatenated bytes of code
+ salt
. (todo #512 code_hash
+ salt
)
Such ProgramId
must not exist in the Program Storage at the time of this call.
There is the same guarantee here as in upload_code
. That is, future program’s
code
and metadata are stored before message was added to the queue and processed.
The origin must be Signed and the sender must have sufficient funds to pay
for gas
and value
(in case the latter is being transferred).
Gear runtime guarantees that an active program always has an account to store value.
If the underlying account management platform (e.g. Substrate’s System pallet) requires
an existential deposit to keep an account alive, the related overhead is considered an
extra cost related with a program instantiation and is charged to the program’s creator
and is released back to the creator when the program is removed.
In context of the above, the value
parameter represents the so-called reducible
balance
a program should have at its disposal upon instantiation. It is not used to offset the
existential deposit required for an account creation.
Parameters:
code
: wasm code of a program as a byte vector.salt
: randomness term (a seed) to allow programs with identical code to be created independently.init_payload
: encoded parameters of the wasm moduleinit
function.gas_limit
: maximum amount of gas the program can spend before it is halted.value
: balance to be transferred to the program once it’s been created.
Emits the following events:
InitMessageEnqueued(MessageInfo)
when init message is placed in the queue.
§Note
Faulty (uninitialized) programs still have a valid addresses (program ids) that can deterministically be derived on the caller’s side upfront. It means that if messages are sent to such an address, they might still linger in the queue.
In order to mitigate the risk of users’ funds being sent to an address, where a valid program should have resided, while it’s not, such “failed-to-initialize” programs are not silently deleted from the program storage but rather marked as “ghost” programs. Ghost program can be removed by their original author via an explicit call. The funds stored by a ghost program will be release to the author once the program has been removed.
sourcepub fn create_program(
origin: OriginFor<T>,
code_id: CodeId,
salt: Vec<u8>,
init_payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
) -> DispatchResultWithPostInfo
pub fn create_program( origin: OriginFor<T>, code_id: CodeId, salt: Vec<u8>, init_payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, ) -> DispatchResultWithPostInfo
Creates program via code_id
from storage.
Parameters:
code_id
: wasm code id in the code storage.salt
: randomness term (a seed) to allow programs with identical code to be created independently.init_payload
: encoded parameters of the wasm moduleinit
function.gas_limit
: maximum amount of gas the program can spend before it is halted.value
: balance to be transferred to the program once it’s been created.
Emits the following events:
InitMessageEnqueued(MessageInfo)
when init message is placed in the queue.
§NOTE
For the details of this extrinsic, see upload_code
.
sourcepub fn send_message(
origin: OriginFor<T>,
destination: ProgramId,
payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
) -> DispatchResultWithPostInfo
pub fn send_message( origin: OriginFor<T>, destination: ProgramId, payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, ) -> DispatchResultWithPostInfo
Sends a message to a program or to another account.
The origin must be Signed and the sender must have sufficient funds to pay
for gas
and value
(in case the latter is being transferred).
To avoid an undefined behavior a check is made that the destination address is not a program in uninitialized state. If the opposite holds true, the message is not enqueued for processing.
Parameters:
destination
: the message destination.payload
: in case of a program destination, parameters of thehandle
function.gas_limit
: maximum amount of gas the program can spend before it is halted.value
: balance to be transferred to the program once it’s been created.
Emits the following events:
DispatchMessageEnqueued(MessageInfo)
when dispatch message is placed in the queue.
sourcepub fn send_reply(
origin: OriginFor<T>,
reply_to_id: MessageId,
payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
) -> DispatchResultWithPostInfo
pub fn send_reply( origin: OriginFor<T>, reply_to_id: MessageId, payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, ) -> DispatchResultWithPostInfo
Send reply on message in Mailbox
.
Removes message by given MessageId
from callers Mailbox
:
rent funds become free, associated with the message value
transfers from message sender to extrinsic caller.
Generates reply on removed message with given parameters
and pushes it in MessageQueue
.
NOTE: source of the message in mailbox guaranteed to be a program.
NOTE: only user who is destination of the message, can claim value or reply on the message from mailbox.
sourcepub fn claim_value(
origin: OriginFor<T>,
message_id: MessageId,
) -> DispatchResultWithPostInfo
pub fn claim_value( origin: OriginFor<T>, message_id: MessageId, ) -> DispatchResultWithPostInfo
Claim value from message in Mailbox
.
Removes message by given MessageId
from callers Mailbox
:
rent funds become free, associated with the message value
transfers from message sender to extrinsic caller.
NOTE: only user who is destination of the message, can claim value or reply on the message from mailbox.
sourcepub fn run(
origin: OriginFor<T>,
max_gas: Option<GasBalanceOf<T>>,
) -> DispatchResultWithPostInfo
pub fn run( origin: OriginFor<T>, max_gas: Option<GasBalanceOf<T>>, ) -> DispatchResultWithPostInfo
Process message queue
sourcepub fn set_execute_inherent(origin: OriginFor<T>, value: bool) -> DispatchResult
pub fn set_execute_inherent(origin: OriginFor<T>, value: bool) -> DispatchResult
Sets ExecuteInherent
flag.
Requires root origin (eventually, will only be set via referendum)
sourcepub fn claim_value_to_inheritor(
origin: OriginFor<T>,
program_id: ProgramId,
depth: NonZero<u32>,
) -> DispatchResultWithPostInfo
pub fn claim_value_to_inheritor( origin: OriginFor<T>, program_id: ProgramId, depth: NonZero<u32>, ) -> DispatchResultWithPostInfo
Transfers value from chain of terminated or exited programs to its final inheritor.
depth
parameter is how far to traverse to inheritor.
A value of 10 is sufficient for most cases.
§Example of chain
- Program #1 exits (e.g `gr_exit syscall) with argument pointing to user. Balance of program #1 has been sent to user.
- Program #2 exits with inheritor pointing to program #1. Balance of program #2 has been sent to exited program #1.
- Program #3 exits with inheritor pointing to program #2 Balance of program #1 has been sent to exited program #2.
So chain of inheritors looks like: Program #3 -> Program #2 -> Program #1 -> User.
We have programs #1 and #2 with stuck value on their balances. The balances should’ve been transferred to user (final inheritor) according to the chain. But protocol doesn’t traverse the chain automatically, so user have to call this extrinsic.
source§impl<T: Config> Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Pallet<T>where
T::AccountId: Origin,
sourcepub fn send_message_impl(
origin: <T as Config>::AccountId,
destination: ProgramId,
payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
gas_sponsor: Option<<T as Config>::AccountId>,
) -> DispatchResultWithPostInfo
pub fn send_message_impl( origin: <T as Config>::AccountId, destination: ProgramId, payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, gas_sponsor: Option<<T as Config>::AccountId>, ) -> DispatchResultWithPostInfo
Underlying implementation of GearPallet::send_message
.
sourcepub fn send_reply_impl(
origin: <T as Config>::AccountId,
reply_to_id: MessageId,
payload: Vec<u8>,
gas_limit: u64,
value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance,
keep_alive: bool,
gas_sponsor: Option<<T as Config>::AccountId>,
) -> DispatchResultWithPostInfo
pub fn send_reply_impl( origin: <T as Config>::AccountId, reply_to_id: MessageId, payload: Vec<u8>, gas_limit: u64, value: <<T as Config>::Currency as Currency<<T as Config>::AccountId>>::Balance, keep_alive: bool, gas_sponsor: Option<<T as Config>::AccountId>, ) -> DispatchResultWithPostInfo
Underlying implementation of GearPallet::send_reply
.
sourcepub fn upload_code_impl(
origin: <T as Config>::AccountId,
code: Vec<u8>,
) -> DispatchResultWithPostInfo
pub fn upload_code_impl( origin: <T as Config>::AccountId, code: Vec<u8>, ) -> DispatchResultWithPostInfo
Underlying implementation of GearPallet::upload_code
.
Trait Implementations§
source§impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>where
T::AccountId: Origin,
source§fn before_all_runtime_migrations() -> Weight
fn before_all_runtime_migrations() -> Weight
source§impl<T: Config> Callable<T> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Callable<T> for Pallet<T>where
T::AccountId: Origin,
type RuntimeCall = Call<T>
source§impl<T: Config> Get<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> Get<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§impl<T: Config> GetStorageVersion for Pallet<T>
impl<T: Config> GetStorageVersion for Pallet<T>
§type CurrentStorageVersion = StorageVersion
type CurrentStorageVersion = StorageVersion
source§fn current_storage_version() -> Self::CurrentStorageVersion
fn current_storage_version() -> Self::CurrentStorageVersion
source§fn on_chain_storage_version() -> StorageVersion
fn on_chain_storage_version() -> StorageVersion
source§impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
source§fn on_initialize(bn: BlockNumberFor<T>) -> Weight
fn on_initialize(bn: BlockNumberFor<T>) -> Weight
Initialization
source§fn on_finalize(bn: BlockNumberFor<T>)
fn on_finalize(bn: BlockNumberFor<T>)
Finalization
§fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
Hooks::on_finalize
]). Read more§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
§fn offchain_worker(_n: BlockNumber)
fn offchain_worker(_n: BlockNumber)
§fn integrity_test()
fn integrity_test()
source§impl<T: Config> IntegrityTest for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> IntegrityTest for Pallet<T>where
T::AccountId: Origin,
source§fn integrity_test()
fn integrity_test()
Hooks::integrity_test
].source§impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
source§fn offchain_worker(n: BlockNumberFor<T>)
fn offchain_worker(n: BlockNumberFor<T>)
source§impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
source§fn on_finalize(n: BlockNumberFor<T>)
fn on_finalize(n: BlockNumberFor<T>)
Hooks::on_finalize
].source§impl<T: Config> OnGenesis for Pallet<T>
impl<T: Config> OnGenesis for Pallet<T>
source§fn on_genesis()
fn on_genesis()
source§impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
source§impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>where
T::AccountId: Origin,
source§fn on_initialize(n: BlockNumberFor<T>) -> Weight
fn on_initialize(n: BlockNumberFor<T>) -> Weight
Hooks::on_initialize
].source§impl<T: Config> OnRuntimeUpgrade for Pallet<T>where
T::AccountId: Origin,
impl<T: Config> OnRuntimeUpgrade for Pallet<T>where
T::AccountId: Origin,
source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Hooks::on_runtime_upgrade
].source§impl<T: Config> PalletInfoAccess for Pallet<T>
impl<T: Config> PalletInfoAccess for Pallet<T>
source§fn module_name() -> &'static str
fn module_name() -> &'static str
source§fn crate_version() -> CrateVersion
fn crate_version() -> CrateVersion
source§impl<T: Config> WhitelistedStorageKeys for Pallet<T>
impl<T: Config> WhitelistedStorageKeys for Pallet<T>
source§fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
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> Freeze for Pallet<T>
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> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§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>,
§fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
fn checked_into<T>(self) -> Option<T>where
Self: TryInto<T>,
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Conv for T
impl<T> Conv for T
§impl<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
§fn deserialize(
&self,
deserializer: &mut D,
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> IsType<T> for T
impl<T> IsType<T> for T
§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
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) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
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
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
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
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
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
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T
. Read more§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.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
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.