Enum ConfigParamName 

#[non_exhaustive]
pub enum ConfigParamName {
    MaxSha256Buffers,
    MaxCrossInvokeDepth,
    MaxNewContractsPerTx,
    MaxBytestringLen,
    MaxContractSizeBytes,
    MaxSavepointDepth,
    MaxAuthTokenDepth,
    MaxRv32CodeBytes,
    MaxRv32MemoryBytes,
    MaxTxGas,
}

The name a chain execution parameter carries outside its XDR encoding.

The protocol encodes each parameter as a ConfigParam union arm; every surface that has to say which parameter it means spells the arm’s field name instead. hog-devnode’s --network-config NAME=VALUE flag keys its genesis overrides by these names and records them under the same names in a data directory’s bootstrap metadata. This enum is the one place the Rust side spells them, so a parameter cannot reach hog-devnode under a name no parameter has.

Naming a parameter says nothing about which values it admits; that stays hog-devnode’s call, against the ceilings its build was compiled with.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MaxSha256Buffers

NetworkConfigParams::max_sha256_buffers.

MaxCrossInvokeDepth

NetworkConfigParams::max_cross_invoke_depth.

MaxNewContractsPerTx

NetworkConfigParams::max_new_contracts_per_tx.

MaxBytestringLen

NetworkConfigParams::max_bytestring_len.

MaxContractSizeBytes

NetworkConfigParams::max_contract_size_bytes.

MaxSavepointDepth

NetworkConfigParams::max_savepoint_depth.

MaxAuthTokenDepth

NetworkConfigParams::max_auth_token_depth.

MaxRv32CodeBytes

NetworkConfigParams::max_rv32_code_bytes.

MaxRv32MemoryBytes

NetworkConfigParams::max_rv32_memory_bytes.

MaxTxGas

NetworkConfigParams::max_tx_gas.

Implementations

impl ConfigParamName

pub const ALL: &'static [ConfigParamName]

Every parameter this build names, in protocol id order.

pub const fn as_str(self) -> &'static str

The protocol’s field name for this parameter.

pub fn stated_in(self, params: &NetworkConfigParams) -> Option<u64>

The value params states for this parameter, None when unstated.

This is the binding between a name and the field it reads, so a parameter added to one has to be added to the other.

pub fn known_names() -> String

The names this build knows, comma-separated, for diagnostics.

Trait Implementations

impl Clone for ConfigParamName

fn clone(&self) -> ConfigParamName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConfigParamName

impl Debug for ConfigParamName

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

Formats the value using the given formatter.

impl Display for ConfigParamName

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

Formats the value using the given formatter.

impl Eq for ConfigParamName

impl FromStr for ConfigParamName

type Err = UnknownConfigParamName

The associated error which can be returned from parsing.

fn from_str( name: &str, ) -> Result<ConfigParamName, <ConfigParamName as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for ConfigParamName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ConfigParamName

fn cmp(&self, other: &ConfigParamName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ConfigParamName

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ConfigParamName

fn partial_cmp(&self, other: &ConfigParamName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ConfigParamName