Struct TrustThreshold

pub struct TrustThreshold { /* private fields */ }

TrustThreshold defines the level of trust that a client has towards a set of validators of a chain.

A trust threshold is represented as a fraction, i.e., a numerator and a denominator. A typical trust threshold is 1/3 in practice. This type accepts even a value of 0, (numerator = 0, denominator = 0), which is used in the client state of an upgrading client.

Implementations

impl TrustThreshold

pub const ONE_THIRD: TrustThreshold

Constant for a trust threshold of 1/3.

pub const TWO_THIRDS: TrustThreshold

Constant for a trust threshold of 2/3.

pub const ZERO: TrustThreshold

Constant for a trust threshold of 0/0.

pub fn new( numerator: u64, denominator: u64, ) -> Result<TrustThreshold, ClientError>

Instantiate a TrustThreshold with the given denominator and numerator.

The constructor succeeds if long as the resulting fraction is in the range[0, 1).

pub fn numerator(&self) -> u64

The numerator of the fraction underlying this trust threshold.

pub fn denominator(&self) -> u64

The denominator of the fraction underlying this trust threshold.

Trait Implementations

impl BorshDeserialize for TrustThreshold

fn deserialize_reader<__R>(reader: &mut __R) -> Result<TrustThreshold, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for TrustThreshold

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl Clone for TrustThreshold

fn clone(&self) -> TrustThreshold

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrustThreshold

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

Formats the value using the given formatter.

impl Decode for TrustThreshold

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

where __CodecInputEdqy: Input,

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<'de> Deserialize<'de> for TrustThreshold

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TrustThreshold

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

Formats the value using the given formatter.

impl Encode for TrustThreshold

fn size_hint(&self) -> usize

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

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

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 From<TrustThreshold> for Fraction

fn from(t: TrustThreshold) -> Fraction

Converts to this type from the input type.

impl From<TrustThresholdFraction> for TrustThreshold

Conversion from Tendermint domain type into IBC domain type.

fn from(t: TrustThresholdFraction) -> TrustThreshold

Converts to this type from the input type.

impl PartialEq for TrustThreshold

fn eq(&self, other: &TrustThreshold) -> 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 Protobuf<Fraction> for TrustThreshold

fn encode<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode into a buffer in Protobuf format.

fn encode_length_delimited<B>(self, buf: &mut B) -> Result<(), Error>

where B: BufMut,

Encode with a length-delimiter to a buffer in Protobuf format.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode an instance from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Constructor that attempts to decode a length-delimited instance from the buffer.

fn encoded_len(self) -> usize

Returns the encoded length of the message without a length delimiter.

fn encode_vec(self) -> Vec<u8>

Encodes into a Protobuf-encoded Vec<u8>.

fn decode_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance from a Vec<u8> (or equivalent).

fn encode_length_delimited_vec(self) -> Vec<u8>

Encode with a length-delimiter to a Vec<u8> Protobuf-encoded message.

fn decode_length_delimited_vec(v: &[u8]) -> Result<Self, Error>

Constructor that attempts to decode a Protobuf-encoded instance with a length-delimiter from a Vec<u8> or equivalent.

impl Serialize for TrustThreshold

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<Fraction> for TrustThreshold

type Error = DecodingError

The type returned in the event of a conversion error.

fn try_from( value: Fraction, ) -> Result<TrustThreshold, <TrustThreshold as TryFrom<Fraction>>::Error>

Performs the conversion.

impl TypeInfo for TrustThreshold

type Identity = TrustThreshold

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for TrustThreshold

impl EncodeLike for TrustThreshold

impl Eq for TrustThreshold

impl StructuralPartialEq for TrustThreshold