Struct nano_leb128::ULEB128

pub struct ULEB128(_);

A value that can be (de)serialized using unsigned LEB128 variable length compression.

Examples

Deserializing a value that was serialized using unsigned LEB128 variable length compression:

use nano_leb128::ULEB128;

let buf = [0xE5, 0x8E, 0x26];

let (val, len) = ULEB128::read_from(&buf).unwrap();

assert_eq!(u64::from(val), 624485);
assert_eq!(len, 3);

Serializing a value using unsigned LEB128 variable length compression:

use nano_leb128::ULEB128;

let mut buf = [0; 3];

assert_eq!(ULEB128::from(624485).write_into(&mut buf).unwrap(), 3);
assert_eq!(buf, [0xE5, 0x8E, 0x26]);

Methods

impl ULEB128

pub fn read_from(buf: &[u8]) -> Result<(Self, usize), LEB128DecodeError>

Attempts to read an unsigned LEB128 compressed value from a buffer.

On success this will return the decompressed value and the number of bytes that were read.

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

Attempts to write a value into a buffer using unsigned LEB128 compression.

On success this will return the number of bytes that were written.

Trait Implementations

impl PartialEq<ULEB128> for ULEB128

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for ULEB128

impl Copy for ULEB128

impl Debug for ULEB128

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

Formats the value using the given formatter.

impl From<ULEB128> for u64

fn from(uleb128: ULEB128) -> Self

Performs the conversion.

impl From<u64> for ULEB128

fn from(val: u64) -> Self

Performs the conversion.

impl Clone for ULEB128

fn clone(&self) -> ULEB128

Returns a copy of the value.

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

Performs copy-assignment from source.