Struct ibc::ics24_host::identifier::ClientId

pub struct ClientId(_);

Implementations

impl ClientId

pub fn new(ctype: ClientType, counter: u64) -> Result<Self, ValidationError>

Builds a new client identifier. Client identifiers are deterministically formed from two elements: a prefix derived from the client type ctype, and a monotonically increasing counter; these are separated by a dash “-”.

let tm_client_id = ClientId::new(ClientType::Tendermint, 0);
assert!(tm_client_id.is_ok());
tm_client_id.map(|id| { assert_eq!(&id, "07-tendermint-0") });

pub fn as_str(&self) -> &str

Get this identifier as a borrowed &str

pub fn prefix(client_type: ClientType) -> &'static str

Returns one of the prefixes that should be present in any client identifiers. The prefix is deterministic for a given chain type, hence all clients for a Tendermint-type chain, for example, will have the prefix ‘07-tendermint’.

pub fn as_bytes(&self) -> &[u8]

Get this identifier as a borrowed byte slice

Trait Implementations

impl Clone for ClientId

fn clone(&self) -> ClientId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientId

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

Formats the value using the given formatter.

impl Default for ClientId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientId

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

Deserialize this value from the given Serde deserializer.

impl Display for ClientId

This implementation provides a to_string method.

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

Formats the value using the given formatter.

impl Eq for ClientId

impl FromStr for ClientId

type Err = ValidationError

The associated error which can be returned from parsing.

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

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

impl Hash for ClientId

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 ClientId

fn cmp(&self, other: &ClientId) -> 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<ClientId> for ClientId

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

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

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

This method tests for !=.

impl PartialEq<str> for ClientId

Equality check against string literal (satisfies &ClientId == &str).

use std::str::FromStr;
use ibc::ics24_host::identifier::ClientId;
let client_id = ClientId::from_str("clientidtwo");
assert!(client_id.is_ok());
client_id.map(|id| {assert_eq!(&id, "clientidtwo")});

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

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

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

This method tests for !=.

impl PartialOrd<ClientId> for ClientId

fn partial_cmp(&self, other: &ClientId) -> 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 ClientId

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 ClientId

impl StructuralPartialEq for ClientId