Trait Encode

Source

pub trait Encode {
    // Required method
    fn encode_slice<T: AsRef<[u8]>>(
        &self,
        input: T,
        output: &mut [u8],
    ) -> Result<usize, EscnulError>;

    // Provided method
    fn encode<T: AsRef<[u8]>>(&self, input: T) -> Vec<u8> ⓘ { ... }
}

Expand description

Trait for encoding a byte stream into a pre-allocated output buffer.

Required Methods§

Source

fn encode_slice<T: AsRef<[u8]>>( &self, input: T, output: &mut [u8], ) -> Result<usize, EscnulError>

Encode input into output, returning the number of bytes written.

§Errors

EscnulError::BadEscapes if the engine’s escape byte is invalid.
EscnulError::BufferTooSmall if output is too small. The contained Progress tells you how many bytes were produced before running out of space.