Struct ibc::ics24_host::identifier::ChainId

pub struct ChainId { /* fields omitted */ }

This type is subject to future changes.

TODO: ChainId validation is not standardized yet. is_epoch_format will most likely be replaced by validate_chain_id()-style function. See: https://github.com/informalsystems/ibc-rs/pull/304#discussion_r503917283.

Also, contrast with tendermint-rs ChainId type.

Implementations

impl ChainId

pub fn new(name: String, version: u64) -> Self

Creates a new ChainId given a chain name and an epoch number.

The returned ChainId will have the format: {chain name}-{epoch number}.

use ibc::ics24_host::identifier::ChainId;

let epoch_number = 10;
let id = ChainId::new("chainA".to_string(), epoch_number);
assert_eq!(id.version(), epoch_number);

pub fn as_str(&self) -> &str

Get a reference to the underlying string.

pub fn version(&self) -> u64

Extract the version from this chain identifier.

pub fn chain_version(chain_id: &str) -> u64

Extract the version from the given chain identifier.

pub fn is_epoch_format(chain_id: &str) -> bool

is_epoch_format() checks if a chain_id is in the format required for parsing epochs The chainID must be in the form: {chainID}-{version}

use ibc::ics24_host::identifier::ChainId;
assert_eq!(ChainId::is_epoch_format("chainA-0"), false);
assert_eq!(ChainId::is_epoch_format("chainA"), false);
assert_eq!(ChainId::is_epoch_format("chainA-1"), true);

Trait Implementations

impl Clone for ChainId

fn clone(&self) -> ChainId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainId

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

Formats the value using the given formatter.

impl Default for ChainId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChainId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ChainId

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

Formats the value using the given formatter.

impl Eq for ChainId

impl From<Id> for ChainId

fn from(id: Id) -> Self

Performs the conversion.

impl FromStr for ChainId

type Err = ValidationError

The associated error which can be returned from parsing.

fn from_str(id: &str) -> Result<Self, Self::Err>

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

impl Hash for ChainId

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for ChainId

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ChainId> for ChainId

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

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

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

This method tests for !=.

impl PartialOrd<ChainId> for ChainId

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Serialize for ChainId

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for ChainId

impl StructuralPartialEq for ChainId

impl TryFrom<String> for ChainId

type Error = ValidationKind

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.