Skip to main content

SubmitterConfig

Struct SubmitterConfig 

Source
#[non_exhaustive]
pub struct SubmitterConfig { pub depth: u32, pub class: IoClass, }
Expand description

How a crate::Submitter is set up: SubmitterConfig::default().with_depth(128).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§depth: u32

Operations submitted and not yet taken back from reap or wait, at most (1 to crate::MAX_DEPTH; default 64). Also the depth of the submitter’s queue.

§class: IoClass

The class of this submitter’s I/O (PLANNING R5.4).

  • Commit (the default): never paced; its barriers, and on a power-safe store its writes, mark the device’s commits active.
  • Background: its reads and writes go out in pieces of at most StoreOptions::background_io, admitted by its device’s pacing: while the device’s commits are active, one piece of the submitter in flight (unless its group has room), else up to background_unpaced. An operation refused before anything is reserved is NotWritten(Paced) with its buffer (reap and retry); its later pieces wait in the submitter, oldest first, and go out at its next reap or wait, or at its drop. Its buffers (crate::Submitter::take_buf) never hold more than half of a pool class; its barriers and writes never mark commits active. An append whose pieces wait holds back its region’s completed prefix, so a commit syncing that region waits for the submitter’s thread to reap or wait: keep commits and background appends in separate regions.
  • Read: its reads are of the read class, its writes Commit.

Implementations§

Source§

impl SubmitterConfig

Source

pub fn with_depth(self, depth: u32) -> SubmitterConfig

The same, with depth.

Source

pub fn with_class(self, class: IoClass) -> SubmitterConfig

The same, of class.

Trait Implementations§

Source§

impl Clone for SubmitterConfig

Source§

fn clone(&self) -> SubmitterConfig

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 SubmitterConfig

Source§

impl Debug for SubmitterConfig

Source§

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

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

impl Default for SubmitterConfig

Source§

fn default() -> SubmitterConfig

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

impl Eq for SubmitterConfig

Source§

impl PartialEq for SubmitterConfig

Source§

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

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.