Struct iou::SetupFlags

pub struct SetupFlags { /* fields omitted */ }

IoUring initialization flags for advanced use cases.

let no_features = SetupFeatures::empty();

// specify polled IO
let mut ring = IoUring::new_with_flags(32, SetupFlags::IOPOLL, no_features)?;

// assign a kernel thread to poll the submission queue
let mut ring = IoUring::new_with_flags(8, SetupFlags::SQPOLL, no_features)?;

// force the kernel thread to use the same cpu as the submission queue
let mut ring = IoUring::new_with_flags(8,
    SetupFlags::IOPOLL | SetupFlags::SQPOLL | SetupFlags::SQ_AFF, no_features)?;

// setting `SQ_AFF` without `SQPOLL` is an error
assert!(IoUring::new_with_flags(8, SetupFlags::SQ_AFF, no_features).is_err());

Implementations

impl SetupFlags

pub const IOPOLL: SetupFlags

Poll the IO context instead of defaulting to interrupts.

pub const SQPOLL: SetupFlags

Assign a kernel thread to poll the submission queue. Requires elevated privileges to set.

pub const SQ_AFF: SetupFlags

Force the kernel thread created with SQPOLL to be bound to the CPU used by the SubmissionQueue. Requires SQPOLL set.

pub const CQSIZE: SetupFlags

pub const CLAMP: SetupFlags

pub const ATTACH_WQ: SetupFlags

pub const fn empty() -> SetupFlags

Returns an empty set of flags

pub const fn all() -> SetupFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<SetupFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> SetupFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> SetupFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: SetupFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: SetupFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: SetupFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: SetupFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: SetupFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: SetupFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for SetupFlags

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

Formats the value using the given formatter.

impl BitAnd<SetupFlags> for SetupFlags

type Output = SetupFlags

The resulting type after applying the & operator.

fn bitand(self, other: SetupFlags) -> SetupFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<SetupFlags> for SetupFlags

fn bitand_assign(&mut self, other: SetupFlags)

Disables all flags disabled in the set.

impl BitOr<SetupFlags> for SetupFlags

type Output = SetupFlags

The resulting type after applying the | operator.

fn bitor(self, other: SetupFlags) -> SetupFlags

Returns the union of the two sets of flags.

impl BitOrAssign<SetupFlags> for SetupFlags

fn bitor_assign(&mut self, other: SetupFlags)

Adds the set of flags.

impl BitXor<SetupFlags> for SetupFlags

type Output = SetupFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: SetupFlags) -> SetupFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<SetupFlags> for SetupFlags

fn bitxor_assign(&mut self, other: SetupFlags)

Toggles the set of flags.

impl Clone for SetupFlags

fn clone(&self) -> SetupFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SetupFlags

impl Debug for SetupFlags

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

Formats the value using the given formatter.

impl Eq for SetupFlags

impl Extend<SetupFlags> for SetupFlags

fn extend<T: IntoIterator<Item = SetupFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<SetupFlags> for SetupFlags

fn from_iter<T: IntoIterator<Item = SetupFlags>>(iterator: T) -> SetupFlags

Creates a value from an iterator.

impl Hash for SetupFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for SetupFlags

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

Formats the value using the given formatter.

impl Not for SetupFlags

type Output = SetupFlags

The resulting type after applying the ! operator.

fn not(self) -> SetupFlags

Returns the complement of this set of flags.

impl Octal for SetupFlags

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

Formats the value using the given formatter.

impl Ord for SetupFlags

fn cmp(&self, other: &SetupFlags) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<SetupFlags> for SetupFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<SetupFlags> for SetupFlags

fn partial_cmp(&self, other: &SetupFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SetupFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SetupFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SetupFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SetupFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SetupFlags

impl StructuralPartialEq for SetupFlags

impl Sub<SetupFlags> for SetupFlags

type Output = SetupFlags

The resulting type after applying the - operator.

fn sub(self, other: SetupFlags) -> SetupFlags

Returns the set difference of the two sets of flags.

impl SubAssign<SetupFlags> for SetupFlags

fn sub_assign(&mut self, other: SetupFlags)

Disables all flags enabled in the set.

impl UpperHex for SetupFlags

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

Formats the value using the given formatter.