Struct forest_actor::miner::BitFieldQueue

pub struct BitFieldQueue<'db, BS> {
    pub amt: Amt<'db, BitField, BS>,
    /* private fields */
}

Wrapper for working with an AMTChainEpoch*Bitfield functioning as a queue, bucketed by epoch. Keys in the queue are quantized (upwards), modulo some offset, to reduce the cardinality of keys.

Fields

amt: Amt<'db, BitField, BS>

Implementations

impl<'db, BS: BlockStore> BitFieldQueue<'db, BS>

pub fn new(
    store: &'db BS,
    root: &Cid,
    quant: QuantSpec
) -> Result<Self, AmtError>

pub fn add_to_queue(
    &mut self,
    raw_epoch: ChainEpoch,
    values: &BitField
) -> Result<(), Box<dyn StdError>>

Adds values to the queue entry for an epoch.

pub fn add_to_queue_values(
    &mut self,
    epoch: ChainEpoch,
    values: &[usize]
) -> Result<(), Box<dyn StdError>>

pub fn cut(&mut self, to_cut: &BitField) -> Result<(), Box<dyn StdError>>

Cut cuts the elements from the bits in the given bitfield out of the queue, shifting other bits down and removing any newly empty entries.

See the docs on BitField::cut to better understand what it does.

pub fn add_many_to_queue_values(
    &mut self,
    values: &HashMap<ChainEpoch, Vec<usize>>
) -> Result<(), Box<dyn StdError>>

pub fn pop_until(
    &mut self,
    until: ChainEpoch
) -> Result<(BitField, bool), Box<dyn StdError>>

Removes and returns all values with keys less than or equal to until. Modified return value indicates whether this structure has been changed by the call.