Struct VirtQueue 

pub struct VirtQueue { /* private fields */ }

VirtIO queue implementation.

Implementations

impl VirtQueue

pub fn new(size: u16) -> Result<VirtQueue, VirtioError>

Creates a new virtqueue with the given size.

Errors

Returns an error if the size is not a power of 2 or exceeds limits.

pub const fn size(&self) -> u16

Returns the queue size.

pub const fn is_ready(&self) -> bool

Returns whether the queue is ready.

pub const fn set_ready(&mut self, ready: bool)

Sets the queue ready state.

pub fn set_descriptor( &mut self, idx: u16, descriptor: Descriptor, ) -> Result<(), VirtioError>

Updates a descriptor entry.

Errors

Returns an error if the index is out of range.

pub fn add_avail(&mut self, head_idx: u16) -> Result<(), VirtioError>

Adds a descriptor chain head to the available ring.

Errors

Returns an error if the descriptor index is out of range.

pub const fn has_available(&self) -> bool

Checks if there are available descriptors.

pub fn pop_avail(&mut self) -> Option<(u16, DescriptorChain<'_>)>

Pops the next available descriptor chain.

Returns the head descriptor index and the descriptor chain.

pub fn set_event_idx(&mut self, enabled: bool)

Enable or disable EVENT_IDX feature.

pub fn push_used(&mut self, head_idx: u16, len: u32) -> bool

Adds a used descriptor to the used ring.

Returns true if the guest should be notified (interrupt required), false if notification is suppressed (EVENT_IDX or NO_INTERRUPT flag).

pub fn push_used_batch(&mut self, completions: &[(u16, u32)]) -> bool

Push a batch of completions to the used ring.

More efficient than calling push_used() in a loop because notification suppression is checked only once for the entire batch.

pub fn set_avail_event(&mut self, event: u16)

Set the avail_event index for kick suppression (device→guest direction).

pub fn get_descriptor(&self, idx: u16) -> Option<&Descriptor>

Returns a reference to a descriptor.

Trait Implementations

impl Debug for VirtQueue

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

Formats the value using the given formatter.