pub struct WriteToBinaryOffsetWrapper<'a> {
    binary_writer: &'a mut dyn BinaryWrite,
    offset: usize,
    index: usize,
    bytes_remaining: bool,
}
Expand description

Wrapper to convert a binary buffer writer to provide a core::fmt::Write interface with offset tracking. This allows a synchronous writer to use an underlying asynchronous write implementation.

This struct allows a synchronous writer to use the core::fmt::Write interface when there is a limited size buffer underneath. This struct tracks where in the overall write has actually been written to the underlying BinaryWrite implementation.

The expected usage of this tool looks like:

let wrapper = WriteToBinaryOffsetWrapper::new(binary_writer);

// Set the byte index of the long, synchronous write where we should
// actually start passing to the binary writer.
wrapper.set_offset(offset);

// Do the long, synchronous write.
let _ = wrapper.write_fmt(format_args!(...));

if wrapper.bytes_remaining() {
    // Some of the write did not finish (likely that means the binary
    // writer's buffer filled up).
    let next_offset = wrapper.get_index();

    // Now wait for the binary write to finish, and start this process
    // over but from the new offset.
} else {
    // Nothing left to print, we're done!
}

Fields§

§binary_writer: &'a mut dyn BinaryWrite

Binary writer implementation that is asynchronous and has a fixed sized buffer.

§offset: usize

Where to start in the long synchronous write.

§index: usize

Keep track of where in the long synchronous write we are currently displaying.

§bytes_remaining: bool

Track if write() is called, and the binary_writer did not print everything we passed to it. In that case, there are more bytes to write on the next iteration.

Implementations§

source§

impl<'a> WriteToBinaryOffsetWrapper<'a>

source

pub fn new( binary_writer: &'a mut dyn BinaryWrite, ) -> WriteToBinaryOffsetWrapper<'_>

source

pub fn set_offset(&mut self, offset: usize)

Set the byte to start printing from on this iteration. Call this before calling Write.

source

pub fn get_index(&self) -> usize

After printing, get the index we left off on to use as the offset for the next iteration.

source

pub fn bytes_remaining(&self) -> bool

After printing, check if there is more to print that the binary_writer did not print.

Trait Implementations§

source§

impl<'a> Write for WriteToBinaryOffsetWrapper<'a>

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

Auto Trait Implementations§

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> 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>,

§

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>,

§

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.