Struct ApprovalThresholdPolicy

#[non_exhaustive]
pub struct ApprovalThresholdPolicy {
    pub threshold_percentage: Option<i32>,
    pub proposal_duration_in_hours: Option<i32>,
    pub threshold_comparator: Option<ThresholdComparator>,
}

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

Applies only to Hyperledger Fabric.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

threshold_percentage: Option<i32>

The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

proposal_duration_in_hours: Option<i32>

The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions aren't carried out.

threshold_comparator: Option<ThresholdComparator>

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThresholdPercentage to be approved.

Implementations

impl ApprovalThresholdPolicy

pub fn threshold_percentage(&self) -> Option<i32>

The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

pub fn proposal_duration_in_hours(&self) -> Option<i32>

The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions aren't carried out.

pub fn threshold_comparator(&self) -> Option<&ThresholdComparator>

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThresholdPercentage to be approved.

impl ApprovalThresholdPolicy

pub fn builder() -> ApprovalThresholdPolicyBuilder

Creates a new builder-style object to manufacture ApprovalThresholdPolicy.

Trait Implementations

impl Clone for ApprovalThresholdPolicy

fn clone(&self) -> ApprovalThresholdPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApprovalThresholdPolicy

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

Formats the value using the given formatter.

impl PartialEq for ApprovalThresholdPolicy

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