Skip to main content

VolumeFill

Struct VolumeFill 

Source
pub struct VolumeFill {
    pub used_sectors: u16,
    pub free_sectors: u16,
    pub total_sectors: u16,
    pub entries: u32,
}
Expand description

How much room is left on a log, and how close it is to overwriting.

Built from DbStats by from_stats, and reached through TieredDb::volume_fill.

§Why this matters more on a removable volume

Under WritePolicy::OnboardFirst a full volume wraps and overwrites its own oldest copy of data the onboard log may still hold — bad, but recoverable. Under CardFirst the volume holds the only copy of everything past the point it took over, so wrapping is real loss. Neither is reported as an error at the time it happens, because the ring overwriting its tail is normal operation for a log. Watching this is how an operator learns the swap window is closing while there is still time to swap.

Fields§

§used_sectors: u16

Sectors holding data — sealed, plus the one being written.

§free_sectors: u16

Sectors still erased. Writes have this much room before the ring starts reclaiming sectors that hold data.

§total_sectors: u16

Sectors in the volume’s database region.

§entries: u32

Entries the volume holds.

Implementations§

Source§

impl VolumeFill

Source

pub fn from_stats(stats: &DbStats) -> Self

Summarise a volume’s statistics.

Source

pub fn used_permille(&self) -> u16

Fraction of the region holding data, in tenths of a percent (0..=1000).

Tenths rather than percent because a large card has enough sectors that whole percent is a coarse warning, and this crate cannot use floats. Zero when the geometry is empty.

Source

pub fn will_overwrite(&self) -> bool

No erased sectors remain, so the next sector rotation reclaims one that holds data.

The last moment at which swapping the medium still costs nothing: the sector being written is not full yet, so this warns of loss rather than reporting it. A volume configured with enough reserved sectors refuses the write with NoSpace instead of overwriting, which is louder but arrives just as late.

Trait Implementations§

Source§

impl Clone for VolumeFill

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for VolumeFill

Source§

impl Debug for VolumeFill

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for VolumeFill

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for VolumeFill

Source§

impl Format for VolumeFill

Available on crate feature defmt only.
Source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
Source§

impl PartialEq for VolumeFill

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for VolumeFill

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.