Struct chain_impl_mockchain::certificate::VotePlan

pub struct VotePlan {
    vote_start: BlockDate,
    vote_end: BlockDate,
    committee_end: BlockDate,
    proposals: Proposals,
    payload_type: PayloadType,
    committee_public_keys: Vec<MemberPublicKey>,
    voting_token: TokenIdentifier,
}

a vote plan for the voting system

A vote plan defines what is being voted, for how long and how long is the committee supposed to reveal the results.

Fields

vote_start: BlockDate

the vote start validity

vote_end: BlockDate

the duration within which it is possible to vote for one of the proposals of this voting plan.

committee_end: BlockDate

the committee duration is the time allocated to the committee to open the ballots and publish the results on chain

proposals: Proposals

the proposals to vote for

payload_type: PayloadType

vote payload type

committee_public_keys: Vec<MemberPublicKey>

encrypting votes public keys

voting_token: TokenIdentifier

voting token used for weigthing the votes for any proposal in this voteplan

Implementations

impl VotePlan

pub fn new( vote_start: BlockDate, vote_end: BlockDate, committee_end: BlockDate, proposals: Proposals, payload_type: PayloadType, committee_public_keys: Vec<MemberPublicKey>, voting_token: TokenIdentifier ) -> Self

pub fn check_governance(&self, governance: &Governance) -> bool

pub fn is_governance(&self) -> bool

pub fn vote_start(&self) -> BlockDate

pub fn vote_end(&self) -> BlockDate

pub fn committee_start(&self) -> BlockDate

pub fn committee_end(&self) -> BlockDate

pub fn proposals(&self) -> &Proposals

access the proposals associated to this voting plan

pub fn proposals_mut(&mut self) -> &mut Proposals

pub fn payload_type(&self) -> PayloadType

pub fn committee_public_keys(&self) -> &[MemberPublicKey]

pub fn voting_token(&self) -> &TokenIdentifier

pub fn vote_started(&self, date: BlockDate) -> bool

pub fn vote_finished(&self, date: BlockDate) -> bool

pub fn can_vote(&self, date: BlockDate) -> bool

tells if it is possible to vote at the given date

[vote_start..vote_end[: from the start date (included) to the end (not included).

pub fn committee_started(&self, date: BlockDate) -> bool

pub fn committee_finished(&self, date: BlockDate) -> bool

pub fn committee_time(&self, date: BlockDate) -> bool

tells if it is possible to do the committee operations at the given date

[vote_end..committee_end[ from the end of the vote date (included) to the end of the committee (not included).

pub fn serialize_in(&self, bb: ByteBuilder<Self>) -> ByteBuilder<Self>

pub fn serialize(&self) -> ByteArray<Self>

pub fn to_id(&self) -> VotePlanId

build the identifier of the vote plan

this is not a very efficient function so it is better not to call it in tight loop

Trait Implementations

impl Arbitrary for VotePlan

fn arbitrary<G: Gen>(g: &mut G) -> Self

fn shrink(&self) -> Box<dyn Iterator<Item = Self>, Global>

impl Clone for VotePlan

fn clone(&self) -> VotePlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VotePlan

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

Formats the value using the given formatter.

impl DeserializeFromSlice for VotePlan

fn deserialize_from_slice(codec: &mut Codec<&[u8]>) -> Result<Self, ReadError>

fn deserialize_validate_from_slice( codec: &mut Codec<&[u8]> ) -> Result<(), ReadError>

impl From<VotePlan> for Certificate

fn from(vote_plan: VotePlan) -> Self

Converts to this type from the input type.

impl From<VotePlanDef> for VotePlan

fn from(dto: VotePlanDef) -> Self

Converts to this type from the input type.

impl PartialEq<VotePlan> for VotePlan

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

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

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

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

impl Payload for VotePlan

const HAS_DATA: bool = true

const HAS_AUTH: bool = true

type Auth = VotePlanProof

fn payload_data(&self) -> PayloadData<Self>

fn payload_auth_data(auth: &Self::Auth) -> PayloadAuthData<Self>

fn payload_to_certificate_slice( p: PayloadSlice<'_, Self> ) -> Option<CertificateSlice<'_>>

impl Serialize for VotePlan

fn serialized_size(&self) -> usize

Default implementation, not efficient, not recommended to use it

fn serialize<W: Write>(&self, codec: &mut Codec<W>) -> Result<(), WriteError>

fn serialize_as_vec(&self) -> Result<Vec<u8, Global>, WriteError>

Convenience method to serialize into a byte vector.

impl Eq for VotePlan

impl StructuralEq for VotePlan

impl StructuralPartialEq for VotePlan