Struct Contenders

pub struct Contenders {
    pub winner: Option<(ContestedDocumentVotePollWinnerInfo, BlockInfo)>,
    pub contenders: BTreeMap<Identifier, ContenderWithSerializedDocument>,
    pub abstain_vote_tally: Option<u32>,
    pub lock_vote_tally: Option<u32>,
}

Multiple contenders for a vote resolution.

Mapping between the contenders identity IDs and their info. If a contender is not found, it is represented as None.

Fields

winner: Option<(ContestedDocumentVotePollWinnerInfo, BlockInfo)>

The winner if the contest is finished

contenders: BTreeMap<Identifier, ContenderWithSerializedDocument>

Contenders indexed by their identity IDs.

abstain_vote_tally: Option<u32>

Tally of abstain votes.

lock_vote_tally: Option<u32>

Tally of lock votes.

Implementations

impl Contenders

pub fn to_contenders( &self, document_type: &DocumentType, platform_version: &PlatformVersion, ) -> Result<BTreeMap<Identifier, Contender>, Error>

Return a map of deserialized [Contender] objects indexed by their identity IDs.

Trait Implementations

impl<'__de> BorrowDecode<'__de> for Contenders

fn borrow_decode<__D>(decoder: &mut __D) -> Result<Contenders, DecodeError>

where __D: BorrowDecoder<'__de>,

Attempt to decode this type with the given BorrowDecode.

impl Clone for Contenders

fn clone(&self) -> Contenders

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Contenders

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

Formats the value using the given formatter.

impl Decode for Contenders

fn decode<__D>(decoder: &mut __D) -> Result<Contenders, DecodeError>

where __D: Decoder,

Attempt to decode this type with the given Decode.

impl Default for Contenders

fn default() -> Contenders

Returns the “default value” for a type.

impl Encode for Contenders

fn encode<__E>(&self, encoder: &mut __E) -> Result<(), EncodeError>

where __E: Encoder,

Encode a given type.

impl FetchMany<Identifier, Contenders> for ContenderWithSerializedDocument

Fetch multiple contenders for a contested document resource vote poll.

Returns Contender indexed by Identifier.

Supported query types

• [ContestedDocumentVotePollDriveQuery]

type Request = GetContestedResourceVoteStateRequest

Type of request used to fetch multiple objects from Platform.

fn fetch_many<'life0, 'async_trait, Q>( sdk: &'life0 Sdk, query: Q, ) -> Pin<Box<dyn Future<Output = Result<O, Error>> + Send + 'async_trait>>

where Q: 'async_trait + Query<<Self as FetchMany<K, O>>::Request>, Self: Send + 'async_trait, 'life0: 'async_trait,

Fetch (or search) multiple objects on the Dash Platform

fn fetch_many_with_metadata<'life0, 'async_trait, Q>( sdk: &'life0 Sdk, query: Q, settings: Option<RequestSettings>, ) -> Pin<Box<dyn Future<Output = Result<(O, ResponseMetadata), Error>> + Send + 'async_trait>>

where Q: 'async_trait + Query<<Self as FetchMany<K, O>>::Request>, Self: Send + 'async_trait, 'life0: 'async_trait,

Fetch multiple objects from Platform with metadata.

fn fetch_many_with_metadata_and_proof<'life0, 'async_trait, Q>( sdk: &'life0 Sdk, query: Q, settings: Option<RequestSettings>, ) -> Pin<Box<dyn Future<Output = Result<(O, ResponseMetadata, Proof), Error>> + Send + 'async_trait>>

where Q: 'async_trait + Query<<Self as FetchMany<K, O>>::Request>, Self: Send + 'async_trait, 'life0: 'async_trait,

Fetch multiple objects from Platform with metadata and underlying proof.

fn fetch_many_with_limit<'life0, 'async_trait, Q>( sdk: &'life0 Sdk, query: Q, limit: u32, ) -> Pin<Box<dyn Future<Output = Result<O, Error>> + Send + 'async_trait>>

where LimitQuery<Q>: Query<<Self as FetchMany<K, O>>::Request>, Q: 'async_trait + Query<<Self as FetchMany<K, O>>::Request>, Self: Send + 'async_trait, 'life0: 'async_trait,

Fetch multiple objects from Platform with limit.

impl FromIterator<(Identifier, Option<ContenderWithSerializedDocument>)> for Contenders

Create Contenders from an iterator of tuples.

This trait is a requirement of the FetchMany trait.

fn from_iter<T>(iter: T) -> Contenders

where T: IntoIterator<Item = (Identifier, Option<ContenderWithSerializedDocument>)>,

Creates a value from an iterator.

impl FromProof<GetContestedResourceVoteStateRequest> for Contenders

type Request = GetContestedResourceVoteStateRequest

Request type for which this trait is implemented.

type Response = GetContestedResourceVoteStateResponse

Response type for which this trait is implemented.

fn maybe_from_proof_with_metadata<'a, I, O>( request: I, response: O, _network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Option<Contenders>, ResponseMetadata, Proof), Error>

where I: Into<<Contenders as FromProof<GetContestedResourceVoteStateRequest>>::Request>, O: Into<<Contenders as FromProof<GetContestedResourceVoteStateRequest>>::Response>, Contenders: 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn maybe_from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Option<Self>, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Parse and verify the received proof and retrieve the requested object, if any.

fn from_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<Self, Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof.

fn from_proof_with_metadata<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

fn from_proof_with_metadata_and_proof<'a, I, O>( request: I, response: O, network: Network, platform_version: &PlatformVersion, provider: &'a dyn ContextProvider, ) -> Result<(Self, ResponseMetadata, Proof), Error>

where I: Into<Self::Request>, O: Into<Self::Response>, Self: Sized + 'a,

Retrieve the requested object from the proof with metadata.

impl Length for Contenders

fn count_some(&self) -> usize

Return number of non-None elements in the data structure

fn count(&self) -> usize

Return number of all elements in the data structure, including None

impl MockResponse for Contenders

fn mock_serialize(&self, sdk: &MockDashPlatformSdk) -> Vec<u8>

Serialize the object to save into expectations

fn mock_deserialize(sdk: &MockDashPlatformSdk, buf: &[u8]) -> Self

where Self: Sized,

Deserialize the object from expectations

impl PlatformDeserializable for Contenders

fn deserialize_from_bytes(bytes: &[u8]) -> Result<Contenders, ProtocolError>

fn deserialize_from_bytes_no_limit( bytes: &[u8], ) -> Result<Contenders, ProtocolError>

impl PlatformSerializable for Contenders

type Error = ProtocolError

fn serialize_to_bytes( &self, ) -> Result<Vec<u8>, <Contenders as PlatformSerializable>::Error>

fn serialize_consume_to_bytes( self, ) -> Result<Vec<u8>, <Contenders as PlatformSerializable>::Error>

If the trait is not used just do a simple serialize

impl PlatformVersionEncode for Contenders

fn platform_encode<__E>( &self, encoder: &mut __E, platform_version: &PlatformVersion, ) -> Result<(), EncodeError>

where __E: Encoder,

Encode a given type.

impl<'__de> PlatformVersionedBorrowDecode<'__de> for Contenders

fn platform_versioned_borrow_decode<__D>( decoder: &mut __D, platform_version: &PlatformVersion, ) -> Result<Contenders, DecodeError>

where __D: BorrowDecoder<'__de>,

Attempt to decode this type with the given [BorrowDecode].

impl PlatformVersionedDecode for Contenders

fn platform_versioned_decode<__D>( decoder: &mut __D, platform_version: &PlatformVersion, ) -> Result<Contenders, DecodeError>

where __D: Decoder,

Attempt to decode this type with the given Decode.