Struct probe_rs::rtt::UpChannel

pub struct UpChannel(_);

RTT up (target to host) channel.

Implementations

impl UpChannel

pub fn number(&self) -> usize

Returns the number of the channel.

pub fn name(&self) -> Option<&str>

Returns the name of the channel or None if there is none.

pub fn buffer_size(&self) -> usize

Returns the buffer size in bytes. Note that the usable size is one byte less due to how the ring buffer is implemented.

pub fn mode(&self, core: &mut Core<'_>) -> Result<ChannelMode, Error>

Reads the current channel mode from the target and returns its.

See ChannelMode for more information on what the modes mean.

pub fn set_mode(
    &self,
    core: &mut Core<'_>,
    mode: ChannelMode
) -> Result<(), Error>

Changes the channel mode on the target to the specified mode.

See ChannelMode for more information on what the modes mean.

pub fn read(&self, core: &mut Core<'_>, buf: &mut [u8]) -> Result<usize, Error>

Reads some bytes from the channel to the specified buffer and returns how many bytes were read.

This method will not block waiting for data in the target buffer, and may read less bytes than would fit in buf.

pub fn peek(&self, core: &mut Core<'_>, buf: &mut [u8]) -> Result<usize, Error>

Peeks at the current data in the channel buffer, copies data into the specified buffer and returns how many bytes were read.

The difference from read is that this does not discard the data in the buffer.

Trait Implementations

impl Debug for UpChannel

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

Formats the value using the given formatter.

impl RttChannel for UpChannel

fn number(&self) -> usize

Returns the number of the channel.

fn name(&self) -> Option<&str>

Returns the name of the channel or None if there is none.

fn buffer_size(&self) -> usize

Returns the buffer size in bytes. Note that the usable size is one byte less due to how the ring buffer is implemented.