Docs.rs
  • io-uring-0.7.7
    • io-uring 0.7.7
    • Permalink
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • quininer
    • github:tokio-rs:uring-core
    • Dependencies
      • bitflags ^2 normal
      • cfg-if ^1 normal
      • libc ^0.2.98 normal
      • sc ^0.2 normal optional
      • anyhow ^1 dev
      • slab ^0.4 dev
      • socket2 ^0.5 dev
      • bindgen ^0.69 build optional
    • Versions
    • 62.18% of the crate is documented
  • Platform
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate io_uring

io_uring0.7.7

  • All Items

Crate Items

  • Re-exports
  • Modules
  • Structs

Crates

  • io_uring

Crate io_uring

Source
Expand description

The io_uring library for Rust.

The crate only provides a summary of the parameters. For more detailed documentation, see manpage.

Re-exports§

pub use cqueue::CompletionQueue;
pub use register::Probe;
pub use squeue::SubmissionQueue;

Modules§

cqueue
Completion Queue
opcode
Operation codes that can be used to construct squeue::Entrys.
register
Some register syscall related types or parameters.
squeue
Submission Queue
types
Common Linux types not provided by libc.

Structs§

Builder
IoUring build params
IoUring
IoUring instance
Parameters
The parameters that were used to construct an IoUring.
Submitter
Interface for submitting submission queue events in an io_uring instance to the kernel for executing and registering files or buffers with the instance.

Results

Settings
Help
    struct
    io_uring::squeue::SubmissionQueue
    An io_uring instance’s submission queue. This is used to …
    method
    io_uring::squeue::SubmissionQueue::len
    &SubmissionQueue<E> -> usize
    Get the number of submission queue events in the ring …
    method
    io_uring::squeue::SubmissionQueue::dropped
    &SubmissionQueue<E> -> u32
    The number of invalid submission queue entries that have …
    method
    io_uring::squeue::SubmissionQueue::is_full
    &SubmissionQueue<E> -> bool
    Returns true if the submission queue ring buffer has …
    method
    io_uring::squeue::SubmissionQueue::taskrun
    &SubmissionQueue<E> -> bool
    Returns true if completions are pending that should be …
    method
    io_uring::squeue::SubmissionQueue::capacity
    &SubmissionQueue<E> -> usize
    Get the total number of entries in the submission queue …
    method
    io_uring::squeue::SubmissionQueue::is_empty
    &SubmissionQueue<E> -> bool
    Returns true if the submission queue ring buffer is empty.
    method
    io_uring::squeue::SubmissionQueue::cq_overflow
    &SubmissionQueue<E> -> bool
    Returns true if the completion queue ring is overflown.
    method
    io_uring::squeue::SubmissionQueue::need_wakeup
    &SubmissionQueue<E> -> bool
    When is_setup_sqpoll is set, whether the kernel threads …
    method
    io_uring::squeue::SubmissionQueue::need_wakeup_after_intermittent_seqcst
    &SubmissionQueue<E> -> bool
    The effect of Self::need_wakeup, after synchronization …
    method
    io_uring::squeue::SubmissionQueue::drop
    &mut SubmissionQueue<E> -> ()
    method
    io_uring::squeue::SubmissionQueue::sync
    &mut SubmissionQueue<E> -> ()
    Synchronize this type with the real submission queue.
    method
    io_uring::squeue::SubmissionQueue::fmt
    &SubmissionQueue<E>, &mut Formatter -> Result
    method
    io_uring::squeue::SubmissionQueue::push
    &mut SubmissionQueue<E>, &E -> Result<(), PushError>
    Attempts to push an entry into the queue. If the queue is …
    method
    io_uring::squeue::SubmissionQueue::push_multiple
    &mut SubmissionQueue<E>, &[E] -> Result<(), PushError>
    Attempts to push several entries into the queue. If the …
    method
    io_uring::IoUring::submission_shared
    &IoUring<S, C> -> SubmissionQueue<S>
    Get the submission queue of the io_uring instance from a …
    method
    io_uring::IoUring::submission
    &mut IoUring<S, C> -> SubmissionQueue<S>
    Get the submission queue of the io_uring instance. This is …
    method
    io_uring::IoUring::split
    &mut IoUring<S, C> -> (Submitter, SubmissionQueue<S>, CompletionQueue<C>)
    Get the submitter, submission queue and completion queue …