Struct TrustThresholdFraction

pub struct TrustThresholdFraction { /* private fields */ }

TrustThresholdFraction defines what fraction of the total voting power of a known and trusted validator set is sufficient for a commit to be accepted going forward. The Default::default() returns true, iff at least a third of the trusted voting power signed (in other words at least one honest validator signed). Some clients might require more than +1/3 and can implement their own TrustThreshold which can be passed into all relevant methods.

Implementations

impl TrustThresholdFraction

pub const ONE_THIRD: Self

Constant for a trust threshold of 1/3.

pub const TWO_THIRDS: Self

Constant for a trust threshold of 2/3.

pub fn new(numerator: u64, denominator: u64) -> Result<Self, Error>

Instantiate a TrustThresholdFraction if the given denominator and numerator are valid.

The parameters are valid iff 1/3 <= numerator/denominator <= 1. In any other case we return an error.

pub fn numerator(&self) -> u64

The numerator of this fraction.

pub fn denominator(&self) -> u64

The denominator of this fraction.

Trait Implementations

impl Clone for TrustThresholdFraction

fn clone(&self) -> TrustThresholdFraction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrustThresholdFraction

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

Formats the value using the given formatter.

impl Default for TrustThresholdFraction

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TrustThresholdFraction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TrustThresholdFraction

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

Formats the value using the given formatter.

impl From<TrustThresholdFraction> for RawTrustThresholdFraction

fn from(f: TrustThresholdFraction) -> Self

Converts to this type from the input type.

impl PartialEq for TrustThresholdFraction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TrustThreshold for TrustThresholdFraction

fn is_enough_power( &self, signed_voting_power: u64, total_voting_power: u64, ) -> bool

Check whether the given signed voting power is sufficient according to this trust threshold against the given total voting power.

impl TryFrom<RawTrustThresholdFraction> for TrustThresholdFraction

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for TrustThresholdFraction

impl Eq for TrustThresholdFraction

impl StructuralPartialEq for TrustThresholdFraction