Struct input_mgr::Line

pub struct Line<const C: usize> { /* private fields */ }

A single line with fixed capacity for C characters

At the moment, C must be <= 255.

This Line acts more or less like a small, fixed size vector of ascii characters

Lines ONLY contain valid ascii characters, that are not control characters.

Implementations

impl<const C: usize> Line<C>

pub const fn new() -> Self

Create a new empty line

pub fn status(&self) -> Source

The source of the current line, either Local or Remote

pub fn len(&self) -> usize

The currently used number of bytes in this line

pub fn is_empty(&self) -> bool

Is the current line empty?

pub fn is_full(&self) -> bool

Is the current line full?

pub fn pop(&mut self)

Pop a character from the END of the line (if any)

pub fn as_str(&self) -> &str

Obtain the current line as a &str

pub const fn cap_u8() -> u8

pub fn extend(&mut self, s: &str) -> Result<(), LineError>

Extend the current line with the given string slice.

Returns an error if the provided slice would not fit, or if any characters are invalid ascii or ascii control characters

pub fn overwrite(&mut self, pos: usize, ovrw: u8) -> Result<(), LineError>

Overwrite an ascii character at the given position

Returns an error if the provided location would leave a gap (beyond the end of the current line), or if the given character is invalid ascii or an ascii control character

pub fn not_full(&self) -> Result<(), LineError>

Returns an error if the line is full

pub fn push(&mut self, ins: u8) -> Result<(), LineError>

Push an ascii character to the end of the line

Returns an error if the provided character would not fit, or if the character is invalid ascii or an ascii control character

pub fn insert(&mut self, pos: usize, ins: u8) -> Result<(), LineError>

Insert an ascii character at the given position

Returns an error if the provided location would leave a gap (beyond the end of the current line), or if the given character is invalid ascii or an ascii control character, or if the line is already full

Trait Implementations

impl<const C: usize> Debug for Line<C>

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

Formats the value using the given formatter.