Struct VirtioConsole 

pub struct VirtioConsole { /* private fields */ }

VirtIO console device.

Implementations

impl VirtioConsole

pub const FEATURE_SIZE: u64

Feature: Console size.

pub const FEATURE_MULTIPORT: u64

Feature: Multiport.

pub const FEATURE_EMERG_WRITE: u64

Feature: Emergency write.

pub const FEATURE_VERSION_1: u64

VirtIO 1.0 feature.

pub fn new(config: ConsoleConfig) -> Self

Creates a new console device.

pub fn with_stdio() -> Self

Creates a console with standard I/O.

pub fn set_io(&mut self, io: Arc<Mutex<dyn ConsoleIo>>)

Sets the console I/O handler.

pub fn queue_input(&mut self, data: &[u8]) -> Result<()>

Queues input data to be read by the guest.

Errors

Returns an error if the console is not active.

pub fn read_output(&mut self) -> Vec<u8>

Reads output data written by the guest.

pub fn process_tx_queue(&mut self, memory: &[u8]) -> Result<Vec<(u16, u32)>>

Processes the transmit queue.

Errors

Returns an error if processing fails.

pub fn rx_available(&self) -> usize

Gets the number of bytes available for RX.

pub fn process_rx_queue( &mut self, memory: &mut [u8], queue_config: &QueueConfig, ) -> Result<bool>

Injects pending host input (queued via queue_input) into the guest RX queue (queue 0), advancing the used ring.

Descriptors are read directly from guest memory — the HV path drives the queue from QueueConfig rather than the internal VirtQueue. Returns true if at least one descriptor was filled, in which case the caller must raise an INT_VRING interrupt so the guest services the input.

Errors

Returns an error if a queue address lies below the guest RAM base.

Trait Implementations

impl Drop for VirtioConsole

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl VirtioDevice for VirtioConsole

fn device_id(&self) -> VirtioDeviceId

Returns the device type ID.

fn features(&self) -> u64

Returns the device features.

fn ack_features(&mut self, features: u64)

Acknowledges features from the driver.

fn read_config(&self, offset: u64, data: &mut [u8])

Reads from the device configuration space.

fn write_config(&mut self, offset: u64, data: &[u8])

Writes to the device configuration space.

fn activate(&mut self) -> Result<()>

Activates the device.

fn reset(&mut self)

Resets the device.

fn process_queue( &mut self, queue_idx: u16, memory: &mut [u8], queue_config: &QueueConfig, ) -> Result<Vec<(u16, u32)>>

Processes pending buffers in the specified queue.