Skip to main content

SizeApproximationOptions

Struct SizeApproximationOptions 

Source
pub struct SizeApproximationOptions { /* private fields */ }
Expand description

Options for the _with_options variants of DB::get_approximate_sizes.

At least one of set_include_memtables, set_include_files and set_include_blob_files has to be on, or there is nothing left to measure.

Implementations§

Source§

impl SizeApproximationOptions

Source

pub fn new() -> SizeApproximationOptions

Source

pub fn set_include_memtables(&mut self, include: bool)

Counts data still sitting in the memtables.

Default: false

Source

pub fn get_include_memtables(&self) -> bool

Returns the value of the include_memtables option.

Source

pub fn set_include_files(&mut self, include: bool)

Counts data written out to SST files.

Default: true

Source

pub fn get_include_files(&self) -> bool

Returns the value of the include_files option.

Source

pub fn set_include_blob_files(&mut self, include: bool)

Counts a share of the blob files, prorated by how much of the SST data falls in the range:

blob_size_in_range ~= total_blob_size * (sst_in_range / total_sst)

That assumes blob values are spread evenly across keys, so it skews when value sizes vary a lot. It also reports zero blob bytes when every key is still in a memtable, because there is no SST data to prorate against.

Default: false

Source

pub fn get_include_blob_files(&self) -> bool

Returns the value of the include_blob_files option.

Source

pub fn set_files_size_error_margin(&mut self, margin: f64)

Lets the file-size estimate be off by up to total_files_size * margin in exchange for doing less work, so 0.1 allows a 10% error.

Zero or negative asks for the precise and more CPU intensive walk.

Source

pub fn get_files_size_error_margin(&self) -> f64

Returns the value of the files_size_error_margin option.

Trait Implementations§

Source§

impl Default for SizeApproximationOptions

Source§

fn default() -> Self

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

impl Drop for SizeApproximationOptions

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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, 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.