Struct WriteBuffer

Source
pub struct WriteBuffer<const N: usize> { /* private fields */ }
Expand description

A write buffer

Implementations§

Source§

impl<const N: usize> WriteBuffer<N>

Source

pub fn new() -> Self

Creates a write buffer

Examples found in repository?
examples/basic.rs (line 5)
4
5
6
7
8
9
fn main() {
    let mut buffer: WriteBuffer<20> = WriteBuffer::new();
    let x = 12;
    write!(buffer, "{}", x).unwrap();
    assert_eq!(buffer.as_str(), "12");
}
Source

pub fn as_slice(&self) -> &[u8]

Returns a slice containing the already written bytes in the buffer

Source

pub fn reset(&mut self)

Reset the buffer such that it can be reused.

Note: This does not overwrite any data in memory, it only sets the internal cursor back to the start of the buffer.

Source

pub fn as_str(&self) -> &str

Converts the buffer into &str.

Examples found in repository?
examples/basic.rs (line 8)
4
5
6
7
8
9
fn main() {
    let mut buffer: WriteBuffer<20> = WriteBuffer::new();
    let x = 12;
    write!(buffer, "{}", x).unwrap();
    assert_eq!(buffer.as_str(), "12");
}
Source

pub fn as_str_mut(&mut self) -> &mut str

Converts the buffer into &mut str.

Source

pub fn len(&self) -> usize

Returns how many bytes in the buffer have already been written.

Source

pub fn is_empty(&self) -> bool

Returns true if zero bytes in the buffer are written.

Source

pub fn remaining(&self) -> usize

Returns how many bytes in the buffer remain for writing.

Source

pub fn is_full(&self) -> bool

Returns true if the buffer is full.

Trait Implementations§

Source§

impl<const N: usize> Clone for WriteBuffer<N>

Source§

fn clone(&self) -> WriteBuffer<N>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<const N: usize> Debug for WriteBuffer<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: usize> Default for WriteBuffer<N>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<const N: usize> Display for WriteBuffer<N>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<const N: usize> Hash for WriteBuffer<N>

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<const N: usize> PartialEq for WriteBuffer<N>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<const N: usize> Write for WriteBuffer<N>

Source§

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

Writes a string slice into this writer, returning whether the write succeeded. Read more
1.1.0 · Source§

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

Writes a char into this writer, returning whether the write succeeded. Read more
1.0.0 · Source§

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

Glue for usage of the write! macro with implementors of this trait. Read more
Source§

impl<const N: usize> Copy for WriteBuffer<N>

Source§

impl<const N: usize> Eq for WriteBuffer<N>

Auto Trait Implementations§

§

impl<const N: usize> Freeze for WriteBuffer<N>

§

impl<const N: usize> RefUnwindSafe for WriteBuffer<N>

§

impl<const N: usize> Send for WriteBuffer<N>

§

impl<const N: usize> Sync for WriteBuffer<N>

§

impl<const N: usize> Unpin for WriteBuffer<N>

§

impl<const N: usize> UnwindSafe for WriteBuffer<N>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.