Skip to main content

RegionOptions

Struct RegionOptions 

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

A region’s size, and the most it may ever grow to.

use store_io_engine::RegionOptions;

// 64 MiB now, never more than 1 GiB: one extent of 1 GiB, so the
// region grows to its cap without new space or a second extent.
let opts = RegionOptions::default().size(64 << 20).max_size(1 << 30);
assert!(opts.validate().is_ok());
assert!(RegionOptions::default().size(2).max_size(1).validate().is_err());

Implementations§

Source§

impl RegionOptions

Source

pub const fn size(self, bytes: u64) -> Self

The data size to provision, in bytes (rounded up to the block; a page or append region holds at least one block).

Source

pub const fn max_size(self, bytes: u64) -> Self

The most the region may ever grow to, in bytes (rounded up to the block). Container format 2 only: the region is placed as one extent of this capacity (its space held from the start, charged to its tag) and grows within it, one run, with no new space; growth past it is NoSpace(RegionLimit). Without it a region grows by new extents while the container has room.

The space past the size is allocated, not written, where the system can (Linux); on Windows and macOS it is written at provisioning (a 64 GiB cap is a 64 GiB write, during which other provisioning and space reports wait), and each growth within it writes its range again (as everywhere).

Source

pub const fn size_bytes(&self) -> u64

The data size asked for.

Source

pub const fn max_size_bytes(&self) -> Option<u64>

The cap asked for, if any.

Source

pub fn validate(&self) -> Result<(), Error>

Checks the options alone (no store needed).

§Errors

NotWritten(InvalidOptions) for a cap below the size.

Trait Implementations§

Source§

impl Clone for RegionOptions

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 RegionOptions

Source§

impl Debug for RegionOptions

Source§

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

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

impl Default for RegionOptions

Source§

fn default() -> Self

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

impl Eq for RegionOptions

Source§

impl PartialEq for RegionOptions

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 RegionOptions

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.