Struct TerminalChannel

pub struct TerminalChannel { /* private fields */ }

An up channel that supports writing into multiple virtual terminals within the same buffer.

An UpChannel can be turned into a TerminalChannel by using the into_terminal method.

Virtual terminals allow you to share one buffer for writing multiple streams. The virtual terminals number from 0 to 15 and are implemented with a simple “terminal switch” sequence on the fly, so there is no need to declare them in advance. You could, for example, use different terminal numbers for messages of different priorities to separate them in a viewer program. Printing uses a TerminalChannel internally.

Implementations

impl TerminalChannel

pub fn write(&mut self, number: u8) -> TerminalWriter<'_>

Creates a writer to write a message to the virtual terminal specified by number.

The correct way to use this method is to call it once for each write operation. This is so that non blocking modes will work correctly.

The writer supports formatted writing with the standard Write and ufmt_write::uWrite.

pub fn mode(&self) -> ChannelMode

Gets the current blocking mode of the channel. The default is NoBlockSkip.

pub fn set_mode(&mut self, mode: ChannelMode)

Sets the blocking mode of the channel

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

pub fn flush(&self)

Wait until all data has been read by the debugger.

Note: This means that if no debugger is connected or if it isn’t reading the rtt data, this function will wait indefinitely.