Trait Varint 

pub trait Varint:
    Clone
    + Copy
    + Debug
    + Default
    + Eq
    + Hash
    + Ord
    + PartialEq
    + PartialOrd
    + Sized
    + Sealed {
    type Buf: Default + 'static;

    const MAX_LEN: usize;

    // Required methods
    fn encoded_len(self) -> usize;
    fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>;
    fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>
       where I: IntoIterator<Item = u8>;
    fn write(self, buf: &mut Self::Buf) -> &[u8] ;
    fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>;
}

An integer that can be LEB128-encoded.

Required Associated Constants

const MAX_LEN: usize

The maximum size in bytes of the encoded integer.

Required Associated Types

type Buf: Default + 'static

A fixed-size buffer.

Is always [u8; Self::MAX_LEN].

Required Methods

fn encoded_len(self) -> usize

Returns the number of bytes needed to encode the integer.

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

Decodes a LEB128-encoded integer from buf.

It returns the decoded integer and the number of bytes read.

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

Decodes a LEB128-encoded integer from iter.

It returns the decoded integer and the number of bytes read.

fn write(self, buf: &mut Self::Buf) -> &[u8]

Encodes x into buf in LEB128 format, returning the portion of buf that was written to.

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

Tries to encode x in LEB128 format.

It returns the portion of buf that was written to, or None if buf is too small to fit x.

In order to succeed, buf should be at least encoded_len bytes.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl Varint for i8

const MAX_LEN: usize = 2usize

type Buf = [u8; 2]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for i16

const MAX_LEN: usize = 3usize

type Buf = [u8; 3]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for i32

const MAX_LEN: usize = 5usize

type Buf = [u8; 5]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for i64

const MAX_LEN: usize = 10usize

type Buf = [u8; 10]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for i128

const MAX_LEN: usize = 19usize

type Buf = [u8; 19]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for isize

const MAX_LEN: usize = 10usize

type Buf = [u8; 10]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for u8

const MAX_LEN: usize = 2usize

type Buf = [u8; 2]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for u16

const MAX_LEN: usize = 3usize

type Buf = [u8; 3]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for u32

const MAX_LEN: usize = 5usize

type Buf = [u8; 5]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for u64

const MAX_LEN: usize = 10usize

type Buf = [u8; 10]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for u128

const MAX_LEN: usize = 19usize

type Buf = [u8; 19]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

impl Varint for usize

const MAX_LEN: usize = 10usize

type Buf = [u8; 10]

fn encoded_len(self) -> usize

fn read(buf: &[u8]) -> Result<(Self, usize), Overflow>

fn read_iter<I>(iter: I) -> Result<(Self, usize), Overflow>

where I: IntoIterator<Item = u8>,

fn write(self, buf: &mut Self::Buf) -> &[u8]

fn try_write(self, buf: &mut [u8]) -> Option<&[u8]>

Implementors