Struct Bitfield

pub struct Bitfield {
    pub ranges: ChunkRanges,
    /* private fields */
}

The state of a bitfield, or an update to a bitfield

Fields

ranges: ChunkRanges

The ranges that were added

Implementations

impl Bitfield

pub fn new(ranges: ChunkRanges, size: u64) -> Self

pub fn size(&self) -> u64

pub fn empty() -> Self

An empty bitfield. This is the neutral element for the combine operation.

pub fn complete(size: u64) -> Self

Create a complete bitfield for the given size

pub fn is_validated(&self) -> bool

True if the chunk corresponding to the size is included in the ranges

pub fn is_complete(&self) -> bool

True if all chunks up to size are included in the ranges

pub fn validated_size(&self) -> Option<u64>

Get the validated size if the bitfield is validated

pub fn total_bytes(&self) -> u64

Total valid bytes in this bitfield.

pub fn state(&self) -> BitfieldState

pub fn update(&mut self, update: &Bitfield) -> UpdateResult

Update the bitfield with a new value, and gives detailed information about the change.

returns a tuple of (changed, Some((old, new))). If the bitfield changed at all, the flag is true. If there was a significant change, the old and new states are returned.

pub fn is_empty(&self) -> bool

pub fn diff(&self, that: &Bitfield) -> Self

A diff between two bitfields. This is an inverse of the combine operation.

Trait Implementations

impl Clone for Bitfield

fn clone(&self) -> Bitfield

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitfield

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

Formats the value using the given formatter.

impl Default for Bitfield

fn default() -> Bitfield

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Bitfield

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<&Bitfield> for ObserveItem

fn from(value: &Bitfield) -> Self

Converts to this type from the input type.

impl From<&ObserveItem> for Bitfield

fn from(value: &ObserveItem) -> Self

Converts to this type from the input type.

impl PartialEq for Bitfield

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for Bitfield

impl StructuralPartialEq for Bitfield