Struct ClientId

pub struct ClientId(/* private fields */);

An IBC 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 “-”.

Implementations

impl ClientId

pub fn new( client_type: ClientType, counter: u64, ) -> Result<ClientId, IdentifierError>

Construct a new client identifier from a client type and a counter.

let tm_client_id = ClientId::new(ClientType::new("07-tendermint".to_string()), 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 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.

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

Performs copy-assignment from source.

impl Debug for ClientId

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

Formats the value using the given formatter.

impl Default for ClientId

fn default() -> ClientId

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<ClientId, <__D as Deserializer<'de>>::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 FromStr for ClientId

type Err = IdentifierError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ClientId, <ClientId as FromStr>::Err>

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

impl Hash for ClientId

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 ClientId

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

impl PartialEq<ClientId> for str

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for ClientId

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ClientId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ClientId

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for ClientId

type Error = IdentifierError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<ClientId, <ClientId as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for ClientId

impl StructuralPartialEq for ClientId