[−][src]Crate ruspiro_console
Console abstraction
This crate provides a console abstraction to enable string output to a configurable output channel.
It also provides the convinient macros (print!
and println!
) to output text that are usually not
available in [no_std]
environments. However this crate also provide macros to indicate the severity of the
message that shall be printed. Those are info!
, warn!
and error!
.
Dependencies
This crate uses macros to provide formatted strings. This formatting requires a memory allocator to
be present (as part of the alloc
crate). So when using this crate provide an allocator such as
ruspiro_allocator
.
Example
To actually set an active output channel you need to provide a structure that implements the ConsoleImpl
trait. This
for example is done in the Uart like so:
impl ConsoleImpl for Uart1 { fn putc(&self, c: char) { self.send_char(c); } fn puts(&self, s: &str) { self.send_string(s); } }
If this trait has been implemented this structure can be used as actual console. To use it there should be the following code written at the earliest possible point in the main crate of the binary (e.g. the kernel)
use ruspiro_console::*; use ruspiro_uart::*; // as we demonstrate with the Uart. fn main() { let mut uart = Uart1::new(); // create a new uart struct if uart.initialize(250_000_000, 115_200).is_ok() { // initialize the Uart with fixed core rate and baud rate CONSOLE.take_for(|cons| cons.replace(uart)); // from this point CONSOLE takes ownership of Uart // uncommenting the following line will give compiler error as uart is moved // uart.send_string("I'm assigned to a console"); } // if everything went fine uart should be assigned to the console for generic output println!("Console is ready and display's through uart"); }
Re-exports
pub extern crate alloc; |
pub use macros::*; |
Modules
macros | Convinient output macros to print formatted strings to the configured channel of the console |
Macros
error | This macro prefixes the output with "E: <module-path> -". Other than this it works like the |
info | This macro prefixes the output with "I: <module-path> -". Other than this it works like the |
This macro works like the | |
println | This macro works like the |
warn | This macro prefixes the output with "W: <module-path> -". Other than this it works like the |
Structs
Console | The representation of the abstract console |
Statics
CONSOLE | The Console singleton used by print! and println! macros |
Traits
ConsoleImpl | Every "real" console need to implement this trait. Also the explicit Drop trait need to be implemented as the drop method of the implementing console will be called as soon as the actual console does release ownership of it |
Functions
The base printing function hidden behind the print! and println! macro. This function fowards all calls to the generic console which puts the string to the assigned output channel. |