Struct VirtIOConsole

pub struct VirtIOConsole<H: Hal, T: Transport> { /* private fields */ }

Driver for a VirtIO console device.

Only a single port is supported.

Example

use virtio_drivers::device::console::VirtIOConsole;
let mut console = VirtIOConsole::<HalImpl, _>::new(transport)?;

let size = console.size().unwrap().unwrap();
println!("VirtIO console {}x{}", size.rows, size.columns);

for &c in b"Hello console!\n" {
  console.send(c)?;
}

let c = console.recv(true)?;
println!("Read {:?} from console.", c);

Implementations

impl<H: Hal, T: Transport> VirtIOConsole<H, T>

pub fn new(transport: T) -> Result<Self>

Creates a new VirtIO console driver.

pub fn size(&self) -> Result<Option<Size>>

Returns the size of the console, if the device supports reporting this.

pub fn ack_interrupt(&mut self) -> Result<bool>

Acknowledges a pending interrupt, if any, and completes the outstanding finished read request if there is one.

Returns true if new data has been received.

pub fn recv(&mut self, pop: bool) -> Result<Option<u8>>

Returns the next available character from the console, if any.

If no data has been received this will not block but immediately return Ok<None>.

pub fn send(&mut self, chr: u8) -> Result<()>

Sends a character to the console.

pub fn send_bytes(&mut self, buffer: &[u8]) -> Result

Sends one or more bytes to the console.

pub fn emergency_write(&mut self, chr: u8) -> Result<()>

Sends a character to the console using the emergency write feature.

Returns an error if the device doesn’t support emergency write.

Trait Implementations

impl<H: Hal, T: Transport> BufRead for VirtIOConsole<H, T>

fn fill_buf(&mut self) -> Result<&[u8], Self::Error>

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.

impl<H: Hal, T: Transport> Drop for VirtIOConsole<H, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<H: Hal, T: Transport> ErrorType for VirtIOConsole<H, T>

type Error = Error

Error type of all the IO operations on this type.

impl<H: Hal, T: Transport> Read for VirtIOConsole<H, T>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl<H: Hal, T: Transport> ReadReady for VirtIOConsole<H, T>

fn read_ready(&mut self) -> Result<bool, Self::Error>

Get whether the reader is ready for immediately reading.

impl<H: Hal, T: Transport> Write for VirtIOConsole<H, T>

fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl<H: Hal, T: Transport> Write for VirtIOConsole<H, T>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.

impl<H: Hal, T: Transport + Send> Send for VirtIOConsole<H, T>

where VirtQueue<H, QUEUE_SIZE>: Send,

impl<H: Hal, T: Transport + Sync> Sync for VirtIOConsole<H, T>

where VirtQueue<H, QUEUE_SIZE>: Sync,