Skip to main content

FixedBuffer

Struct FixedBuffer 

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

Fixed-size, owned buffer implementing core::fmt::Write.

  • Completely no_std and allocation-free.
  • Capacity is a const generic N.
  • On overflow, write_str returns Err(fmt::Error) (no partial writes).

Implementations§

Source§

impl<const N: usize> FixedBuffer<N>

Source

pub const fn new() -> Self

Create a new empty buffer.

Source

pub const fn capacity(&self) -> usize

Maximum capacity in bytes.

Source

pub fn len(&self) -> &usize

Number of bytes currently written.

Source

pub const fn is_empty(&self) -> bool

Returns true if the buffer is empty.

Source

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

Access the written portion as bytes.

Source

pub fn as_str(&self) -> &str

Access the written portion as &str.

Panics if the contents are not valid UTF-8, which is fine for telemetry because we only ever write ASCII.

Source

pub fn clear(&mut self)

Clear the buffer without reallocating.

Trait Implementations§

Source§

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

Source§

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

Returns a duplicate 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> Default for FixedBuffer<N>

Source§

fn default() -> Self

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

impl<const N: usize> Write for FixedBuffer<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 FixedBuffer<N>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<const N: usize> UnsafeUnpin for FixedBuffer<N>

§

impl<const N: usize> UnwindSafe for FixedBuffer<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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.