Struct ckb_proposal_table::ProposalTable

pub struct ProposalTable { /* fields omitted */ }

A Table record proposals set in number-ids pairs

Implementations

impl ProposalTable

pub fn new(proposal_window: ProposalWindow) -> Self

Create new ProposalTable from ProposalWindow

pub fn insert(
    &mut self,
    number: BlockNumber,
    ids: HashSet<ProposalShortId>
) -> bool

Inserts a number-ids pair into the table. If the TABLE did not have this number present, true is returned. If the map did have this number present, the proposal set is updated.

pub fn remove(
    &mut self,
    number: BlockNumber
) -> Option<HashSet<ProposalShortId>>

Removes a proposal set from the table,　returning the set at the number if the number was previously in the table

Examples

use ckb_chain_spec::consensus::ProposalWindow;
use ckb_proposal_table::ProposalTable;

let window = ProposalWindow(2, 10);
let mut table = ProposalTable::new(window);
assert_eq!(table.remove(1), None);

pub fn all(&self) -> &BTreeMap<BlockNumber, HashSet<ProposalShortId>>

Return referent of internal BTreeMap contains all proposal set

pub fn finalize(
    &mut self,
    origin: &ProposalView,
    number: BlockNumber
) -> (HashSet<ProposalShortId>, ProposalView)

Update table by proposal window move froward, drop outdated proposal set Return removed proposal ids set and new ProposalView

Trait Implementations

impl Clone for ProposalTable

fn clone(&self) -> ProposalTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProposalTable

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

Formats the value using the given formatter.

impl Eq for ProposalTable

impl PartialEq<ProposalTable> for ProposalTable

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

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

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

This method tests for !=.

impl StructuralEq for ProposalTable

impl StructuralPartialEq for ProposalTable