Enum gear_common::gas_provider::GasNode

pub enum GasNode<ExternalId: Clone, Id: Clone, Balance: Zero + Clone, Funds> {
    External {
        id: ExternalId,
        multiplier: GasMultiplier<Funds, Balance>,
        value: Balance,
        lock: NodeLock<Balance>,
        system_reserve: Balance,
        refs: ChildrenRefs,
        consumed: bool,
        deposit: bool,
    },
    Cut {
        id: ExternalId,
        multiplier: GasMultiplier<Funds, Balance>,
        value: Balance,
        lock: NodeLock<Balance>,
    },
    Reserved {
        id: ExternalId,
        multiplier: GasMultiplier<Funds, Balance>,
        value: Balance,
        lock: NodeLock<Balance>,
        refs: ChildrenRefs,
        consumed: bool,
    },
    SpecifiedLocal {
        parent: Id,
        root: Id,
        value: Balance,
        lock: NodeLock<Balance>,
        system_reserve: Balance,
        refs: ChildrenRefs,
        consumed: bool,
    },
    UnspecifiedLocal {
        parent: Id,
        root: Id,
        lock: NodeLock<Balance>,
        system_reserve: Balance,
    },
}

Node of the [‘Tree’] gas tree

Variants

External

Fields

id: ExternalId

multiplier: GasMultiplier<Funds, Balance>

value: Balance

lock: NodeLock<Balance>

system_reserve: Balance

refs: ChildrenRefs

consumed: bool

deposit: bool

A root node for each gas tree.

Usually created when a new gasful logic started (i.e., message sent).

Cut

Fields

id: ExternalId

multiplier: GasMultiplier<Funds, Balance>

value: Balance

lock: NodeLock<Balance>

A node created by “cutting” value from some other tree node.

Such node types are detached and aren’t part of the tree structure (not node’s parent, not node’s child).

Reserved

Fields

id: ExternalId

multiplier: GasMultiplier<Funds, Balance>

value: Balance

lock: NodeLock<Balance>

refs: ChildrenRefs

consumed: bool

A node used for gas reservation feature.

Such node types are detached from initial tree and may act the a root of new tree.

SpecifiedLocal

Fields

parent: Id

root: Id

value: Balance

lock: NodeLock<Balance>

system_reserve: Balance

refs: ChildrenRefs

consumed: bool

A node, which is a part of the tree structure, that can be a parent and/or a child.

As well as External node, it has an internal balance and can exist while being consumed (see Tree::consume for details).

However, it has a parent field pointing to the node, from which that one was created.

UnspecifiedLocal

Fields

parent: Id

root: Id

lock: NodeLock<Balance>

system_reserve: Balance

Pretty same as SpecifiedLocal, but doesn’t have internal balance, so relies on its parent.

Such nodes don’t have children references.

Implementations

impl<ExternalId: Clone, Id: Clone + Copy, Balance: Default + Zero + Clone + Copy + Saturating, Funds: Clone> GasNode<ExternalId, Id, Balance, Funds>

pub fn total_value(&self) -> Balance

Returns total gas value inside GasNode.

impl<ExternalId: Clone, Id: Clone + Copy, Balance: Default + Zero + Clone + Copy, Funds: Clone> GasNode<ExternalId, Id, Balance, Funds>

pub fn new( id: ExternalId, multiplier: GasMultiplier<Funds, Balance>, value: Balance, deposit: bool ) -> Self

Creates a new GasNode::External root node for a new tree.

pub fn increase_spec_refs(&mut self)

Increases node’s spec refs, if it can have any

pub fn decrease_spec_refs(&mut self)

Decreases node’s spec refs, if it can have any

pub fn increase_unspec_refs(&mut self)

Increases node’s unspec refs, if it can have any

pub fn decrease_unspec_refs(&mut self)

Decreases node’s unspec refs, if it can have any

pub fn mark_consumed(&mut self)

Marks the node as consumed, if it has the flag

pub fn is_consumed(&self) -> bool

Returns whether the node is marked consumed or not

Only GasNode::External, GasNode::SpecifiedLocal, GasNode::Reserved can be marked consumed and not deleted. See Tree::consume for details.

pub fn is_patron(&self) -> bool

Returns whether the node is patron or not.

The flag signals whether the node isn’t available for the gas to be spent from it.

These are nodes that have one of the following requirements:

1. Have unspec refs (regardless of being consumed).
2. Are not consumed.

Patron nodes are those on which other nodes of the tree rely (including the self node).

pub fn value(&self) -> Option<Balance>

Returns node’s inner gas balance, if it can have any

pub fn value_mut(&mut self) -> Option<&mut Balance>

Get’s a mutable access to node’s inner gas balance, if it can have any

pub fn lock(&self) -> &NodeLock<Balance>

Returns node’s locked gas balance, if it can have any.

pub fn lock_mut(&mut self) -> &mut NodeLock<Balance>

Get’s a mutable access to node’s locked gas balance, if it can have any.

pub fn system_reserve(&self) -> Option<Balance>

Returns node’s system reserved gas balance, if it can have any.

pub fn system_reserve_mut(&mut self) -> Option<&mut Balance>

Gets a mutable access to node’s system reserved gas balance, if it can have any.

pub fn parent(&self) -> Option<Id>

Returns node’s parent, if it can have any.

That is, GasNode::External, GasNode::Cut, ’GasNode::Reservednodes don't have a parent, so aNone` is returned if the function is called on them.

pub fn refs(&self) -> u32

Returns node’s total refs

pub fn spec_refs(&self) -> u32

Returns node’s spec refs

pub fn unspec_refs(&self) -> u32

Returns node’s unspec refs

pub fn root_id(&self) -> Option<Id>

Returns id of the root node.

pub fn external_data( &self ) -> Option<(ExternalId, GasMultiplier<Funds, Balance>)>

Returns external origin and funds multiplier of the node if contains that data inside.

Trait Implementations

impl<ExternalId: Clone + Clone, Id: Clone + Clone, Balance: Clone + Zero + Clone, Funds: Clone> Clone for GasNode<ExternalId, Id, Balance, Funds>

fn clone(&self) -> GasNode<ExternalId, Id, Balance, Funds>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<ExternalId: Debug + Clone, Id: Debug + Clone, Balance: Debug + Zero + Clone, Funds: Debug> Debug for GasNode<ExternalId, Id, Balance, Funds>

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

Formats the value using the given formatter.

impl<ExternalId, Id, Balance, Funds> Decode for GasNode<ExternalId, Id, Balance, Funds>

where ExternalId: Decode + Clone, GasMultiplier<Funds, Balance>: Decode, Balance: Decode + Zero + Clone, NodeLock<Balance>: Decode, Id: Decode + Clone,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<ExternalId, Id, Balance, Funds> Encode for GasNode<ExternalId, Id, Balance, Funds>

where ExternalId: Encode + Clone, GasMultiplier<Funds, Balance>: Encode, Balance: Encode + Zero + Clone, NodeLock<Balance>: Encode, Id: Encode + Clone,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<ExternalId, Id, Balance, Funds> MaxEncodedLen for GasNode<ExternalId, Id, Balance, Funds>

where ExternalId: MaxEncodedLen + Clone, GasMultiplier<Funds, Balance>: MaxEncodedLen, Balance: MaxEncodedLen + Zero + Clone, NodeLock<Balance>: MaxEncodedLen, Id: MaxEncodedLen + Clone,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<ExternalId: PartialEq + Clone, Id: PartialEq + Clone, Balance: PartialEq + Zero + Clone, Funds: PartialEq> PartialEq for GasNode<ExternalId, Id, Balance, Funds>

fn eq(&self, other: &GasNode<ExternalId, Id, Balance, Funds>) -> bool

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

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<ExternalId, Id, Balance, Funds> TypeInfo for GasNode<ExternalId, Id, Balance, Funds>

where ExternalId: TypeInfo + 'static + Clone, GasMultiplier<Funds, Balance>: TypeInfo + 'static, Balance: TypeInfo + 'static + Zero + Clone, NodeLock<Balance>: TypeInfo + 'static, Id: TypeInfo + 'static + Clone, Funds: TypeInfo + 'static,

type Identity = GasNode<ExternalId, Id, Balance, Funds>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<ExternalId, Id, Balance, Funds> EncodeLike for GasNode<ExternalId, Id, Balance, Funds>

where ExternalId: Encode + Clone, GasMultiplier<Funds, Balance>: Encode, Balance: Encode + Zero + Clone, NodeLock<Balance>: Encode, Id: Encode + Clone,

impl<ExternalId: Eq + Clone, Id: Eq + Clone, Balance: Eq + Zero + Clone, Funds: Eq> Eq for GasNode<ExternalId, Id, Balance, Funds>

impl<ExternalId: Clone, Id: Clone, Balance: Zero + Clone, Funds> StructuralEq for GasNode<ExternalId, Id, Balance, Funds>

impl<ExternalId: Clone, Id: Clone, Balance: Zero + Clone, Funds> StructuralPartialEq for GasNode<ExternalId, Id, Balance, Funds>