Parser

Struct Parser 

Source
pub struct Parser { /* private fields */ }
Expand description

Terminal parser that processes VT100 escape sequences

Uses termwiz for parsing and delegates state management to Screen

Implementations§

Source§

impl Parser

Source

pub fn new(rows: usize, cols: usize, scrollback: usize) -> Self

Create a new parser

Source

pub fn process(&mut self, bytes: &[u8])

Process bytes and update terminal state

Source

pub fn screen(&self) -> &Screen

Get the screen state

Source

pub fn screen_mut(&mut self) -> &mut Screen

Get mutable screen state

Source

pub fn resize(&mut self, rows: usize, cols: usize)

Resize the terminal

Source

pub fn size(&self) -> Size

Get screen size

Source

pub fn scrollback(&self) -> usize

Get scrollback offset

Source

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

Set scrollback offset

Trait Implementations§

Source§

impl Write for Parser

Source§

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written. Read more
Source§

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination. Read more
1.36.0 · Source§

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers. Read more
Source§

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)
Determines if this Writer has an efficient write_vectored implementation. Read more
1.0.0 · Source§

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer. Read more
Source§

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)
Attempts to write multiple buffers into this writer. Read more
1.0.0 · Source§

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

Writes a formatted string into this writer, returning any error encountered. Read more
1.0.0 · Source§

fn by_ref(&mut self) -> &mut Self
where Self: Sized,

Creates a “by reference” adapter for this instance of Write. Read more

Auto Trait Implementations§

§

impl !Freeze for Parser

§

impl !RefUnwindSafe for Parser

§

impl Send for Parser

§

impl !Sync for Parser

§

impl Unpin for Parser

§

impl UnwindSafe for Parser

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ExecutableCommand for T
where T: Write + ?Sized,

Source§

fn execute(&mut self, command: impl Command) -> Result<&mut T, Error>

Executes the given command directly.

The given command its ANSI escape code will be written and flushed onto Self.

§Arguments
  • Command

    The command that you want to execute directly.

§Example
use std::io;
use crossterm::{ExecutableCommand, style::Print};

fn main() -> io::Result<()> {
     // will be executed directly
      io::stdout()
        .execute(Print("sum:\n".to_string()))?
        .execute(Print(format!("1 + 1= {} ", 1 + 1)))?;

      Ok(())

     // ==== Output ====
     // sum:
     // 1 + 1 = 2
}

Have a look over at the Command API for more details.

§Notes
  • In the case of UNIX and Windows 10, ANSI codes are written to the given ‘writer’.
  • In case of Windows versions lower than 10, a direct WinAPI call will be made. The reason for this is that Windows versions lower than 10 do not support ANSI codes, and can therefore not be written to the given writer. Therefore, there is no difference between execute and queue for those old Windows versions.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> QueueableCommand for T
where T: Write + ?Sized,

Source§

fn queue(&mut self, command: impl Command) -> Result<&mut T, Error>

Queues the given command for further execution.

Queued commands will be executed in the following cases:

  • When flush is called manually on the given type implementing io::Write.
  • The terminal will flush automatically if the buffer is full.
  • Each line is flushed in case of stdout, because it is line buffered.
§Arguments
  • Command

    The command that you want to queue for later execution.

§Examples
use std::io::{self, Write};
use crossterm::{QueueableCommand, style::Print};

 fn main() -> io::Result<()> {
    let mut stdout = io::stdout();

    // `Print` will executed executed when `flush` is called.
    stdout
        .queue(Print("foo 1\n".to_string()))?
        .queue(Print("foo 2".to_string()))?;

    // some other code (no execution happening here) ...

    // when calling `flush` on `stdout`, all commands will be written to the stdout and therefore executed.
    stdout.flush()?;

    Ok(())

    // ==== Output ====
    // foo 1
    // foo 2
}

Have a look over at the Command API for more details.

§Notes
  • In the case of UNIX and Windows 10, ANSI codes are written to the given ‘writer’.
  • In case of Windows versions lower than 10, a direct WinAPI call will be made. The reason for this is that Windows versions lower than 10 do not support ANSI codes, and can therefore not be written to the given writer. Therefore, there is no difference between execute and queue for those old Windows versions.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<W> SynchronizedUpdate for W
where W: Write + ?Sized,

Source§

fn sync_update<T>( &mut self, operations: impl FnOnce(&mut W) -> T, ) -> Result<T, Error>

Performs a set of actions within a synchronous update.

Updates will be suspended in the terminal, the function will be executed against self, updates will be resumed, and a flush will be performed.

§Arguments
  • Function

    A function that performs the operations that must execute in a synchronized update.

§Examples
use std::io;
use crossterm::{ExecutableCommand, SynchronizedUpdate, style::Print};

fn main() -> io::Result<()> {
    let mut stdout = io::stdout();

    stdout.sync_update(|stdout| {
        stdout.execute(Print("foo 1\n".to_string()))?;
        stdout.execute(Print("foo 2".to_string()))?;
        // The effects of the print command will not be present in the terminal
        // buffer, but not visible in the terminal.
        std::io::Result::Ok(())
    })?;

    // The effects of the commands will be visible.

    Ok(())

    // ==== Output ====
    // foo 1
    // foo 2
}
§Notes

This command is performed only using ANSI codes, and will do nothing on terminals that do not support ANSI codes, or this specific extension.

When rendering the screen of the terminal, the Emulator usually iterates through each visible grid cell and renders its current state. With applications updating the screen a at higher frequency this can cause tearing.

This mode attempts to mitigate that.

When the synchronization mode is enabled following render calls will keep rendering the last rendered state. The terminal Emulator keeps processing incoming text and sequences. When the synchronized update mode is disabled again the renderer may fetch the latest screen buffer state again, effectively avoiding the tearing effect by unintentionally rendering in the middle a of an application screen update.

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<W> WriteBytesExt for W
where W: Write + ?Sized,

Source§

fn write_u8(&mut self, n: u8) -> Result<(), Error>

Writes an unsigned 8 bit integer to the underlying writer. Read more
Source§

fn write_i8(&mut self, n: i8) -> Result<(), Error>

Writes a signed 8 bit integer to the underlying writer. Read more
Source§

fn write_u16<T>(&mut self, n: u16) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 16 bit integer to the underlying writer. Read more
Source§

fn write_i16<T>(&mut self, n: i16) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 16 bit integer to the underlying writer. Read more
Source§

fn write_u24<T>(&mut self, n: u32) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 24 bit integer to the underlying writer. Read more
Source§

fn write_i24<T>(&mut self, n: i32) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 24 bit integer to the underlying writer. Read more
Source§

fn write_u32<T>(&mut self, n: u32) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 32 bit integer to the underlying writer. Read more
Source§

fn write_i32<T>(&mut self, n: i32) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 32 bit integer to the underlying writer. Read more
Source§

fn write_u48<T>(&mut self, n: u64) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 48 bit integer to the underlying writer. Read more
Source§

fn write_i48<T>(&mut self, n: i64) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 48 bit integer to the underlying writer. Read more
Source§

fn write_u64<T>(&mut self, n: u64) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 64 bit integer to the underlying writer. Read more
Source§

fn write_i64<T>(&mut self, n: i64) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 64 bit integer to the underlying writer. Read more
Source§

fn write_u128<T>(&mut self, n: u128) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned 128 bit integer to the underlying writer.
Source§

fn write_i128<T>(&mut self, n: i128) -> Result<(), Error>
where T: ByteOrder,

Writes a signed 128 bit integer to the underlying writer.
Source§

fn write_uint<T>(&mut self, n: u64, nbytes: usize) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned n-bytes integer to the underlying writer. Read more
Source§

fn write_int<T>(&mut self, n: i64, nbytes: usize) -> Result<(), Error>
where T: ByteOrder,

Writes a signed n-bytes integer to the underlying writer. Read more
Source§

fn write_uint128<T>(&mut self, n: u128, nbytes: usize) -> Result<(), Error>
where T: ByteOrder,

Writes an unsigned n-bytes integer to the underlying writer. Read more
Source§

fn write_int128<T>(&mut self, n: i128, nbytes: usize) -> Result<(), Error>
where T: ByteOrder,

Writes a signed n-bytes integer to the underlying writer. Read more
Source§

fn write_f32<T>(&mut self, n: f32) -> Result<(), Error>
where T: ByteOrder,

Writes a IEEE754 single-precision (4 bytes) floating point number to the underlying writer. Read more
Source§

fn write_f64<T>(&mut self, n: f64) -> Result<(), Error>
where T: ByteOrder,

Writes a IEEE754 double-precision (8 bytes) floating point number to the underlying writer. Read more
Source§

impl<W> WriteEndian<[f32]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[f32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[f32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[f64]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[f64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[f64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[i128]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[i128]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[i128]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[i16]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[i16]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[i16]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[i32]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[i32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[i32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[i64]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[i64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[i64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[i8]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[i8]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[i8]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[u128]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[u128]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[u128]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[u16]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[u16]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[u16]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[u32]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[u32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[u32]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[u64]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[u64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[u64]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<[u8]> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &[u8]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &[u8]) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<f32> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &f32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &f32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<f64> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &f64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &f64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<i128> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &i128) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &i128) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<i16> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &i16) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &i16) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<i32> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &i32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &i32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<i64> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &i64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &i64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<i8> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &i8) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &i8) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<u128> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &u128) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &u128) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<u16> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &u16) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &u16) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<u32> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &u32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &u32) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<u64> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &u64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &u64) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<W> WriteEndian<u8> for W
where W: Write,

Source§

fn write_as_little_endian(&mut self, value: &u8) -> Result<(), Error>

Write the byte value of the specified reference, converting it to little endianness
Source§

fn write_as_big_endian(&mut self, value: &u8) -> Result<(), Error>

Write the byte value of the specified reference, converting it to big endianness
Source§

fn write_as_native_endian(&mut self, value: &T) -> Result<(), Error>

Write the byte value of the specified reference, not converting it
Source§

impl<T> ZByteWriterTrait for T
where T: Write,

Source§

fn write_bytes(&mut self, buf: &[u8]) -> Result<usize, ZByteIoError>

Write some bytes into the sink returning number of bytes written or an error if something bad happened Read more
Source§

fn write_all_bytes(&mut self, buf: &[u8]) -> Result<(), ZByteIoError>

Write all bytes to the buffer or return an error if something occurred Read more
Source§

fn write_const_bytes<const N: usize>( &mut self, buf: &[u8; N], ) -> Result<(), ZByteIoError>

Write a fixed number of bytes and error out if we can’t write the bytes Read more
Source§

fn flush_bytes(&mut self) -> Result<(), ZByteIoError>

Ensure bytes are written to the sink. Read more
Source§

fn reserve_capacity(&mut self, _: usize) -> Result<(), ZByteIoError>

A hint to tell the implementation how big of a size we expect the image to be An implementation like in memory Vec can use this to reserve additional memory to prevent reallocation when encoding Read more