Trait VarIntTarget

pub trait VarIntTarget:
    Debug
    + Eq
    + PartialEq
    + PartialOrd
    + Sized
    + Copy {
    type Signed: SignedVarIntTarget;

    const MAX_VARINT_BYTES: u8;
    const MAX_LAST_VARINT_BYTE: u8;

    // Required methods
    fn vector_to_num(res: [u8; 16]) -> Self;
    fn scalar_to_num(x: u64) -> Self;
    fn cast_u32(num: u32) -> Self;
    fn cast_u64(num: u64) -> Self;
    fn num_to_scalar_stage1(self) -> u64;
    fn num_to_vector_stage1(self) -> [u8; 16];
    fn zigzag(from: Self::Signed) -> Self;
    fn unzigzag(self) -> Self::Signed;
}

Represents an unsigned scalar value that can be encoded to and decoded from a varint.

Required Associated Constants

const MAX_VARINT_BYTES: u8

The maximum length of varint that is necessary to represent this number

const MAX_LAST_VARINT_BYTE: u8

The maximum value of the last byte if the varint is MAX_VARINT_BYTES long such that the varint would not overflow the target

Required Associated Types

type Signed: SignedVarIntTarget

The signed version of this type

Required Methods

fn vector_to_num(res: [u8; 16]) -> Self

Converts a 128-bit vector to this number

Note: Despite operating on 128-bit SIMD vectors, these functions accept and return static arrays due to a lack of optimization capability by the compiler when passing or returning intrinsic vectors.

fn scalar_to_num(x: u64) -> Self

fn cast_u32(num: u32) -> Self

Cast from u32 to self

fn cast_u64(num: u64) -> Self

Cast from u64 to self

fn num_to_scalar_stage1(self) -> u64

Splits this number into 7-bit segments for encoding

fn num_to_vector_stage1(self) -> [u8; 16]

Splits this number into 7-bit segments for encoding

fn zigzag(from: Self::Signed) -> Self

ZigZag encodes this value

fn unzigzag(self) -> Self::Signed

ZigZag decodes this value

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 VarIntTarget for u8

const MAX_VARINT_BYTES: u8 = 2u8

const MAX_LAST_VARINT_BYTE: u8 = 1u8

type Signed = i8

fn vector_to_num(res: [u8; 16]) -> Self

fn scalar_to_num(x: u64) -> Self

fn cast_u32(num: u32) -> Self

fn cast_u64(num: u64) -> Self

fn num_to_scalar_stage1(self) -> u64

fn num_to_vector_stage1(self) -> [u8; 16]

fn zigzag(from: Self::Signed) -> Self

fn unzigzag(self) -> Self::Signed

impl VarIntTarget for u16

const MAX_VARINT_BYTES: u8 = 3u8

const MAX_LAST_VARINT_BYTE: u8 = 3u8

type Signed = i16

fn vector_to_num(res: [u8; 16]) -> Self

fn scalar_to_num(x: u64) -> Self

fn cast_u32(num: u32) -> Self

fn cast_u64(num: u64) -> Self

fn num_to_scalar_stage1(self) -> u64

fn num_to_vector_stage1(self) -> [u8; 16]

fn zigzag(from: Self::Signed) -> Self

fn unzigzag(self) -> Self::Signed

impl VarIntTarget for u32

const MAX_VARINT_BYTES: u8 = 5u8

const MAX_LAST_VARINT_BYTE: u8 = 15u8

type Signed = i32

fn vector_to_num(res: [u8; 16]) -> Self

fn scalar_to_num(x: u64) -> Self

fn cast_u32(num: u32) -> Self

fn cast_u64(num: u64) -> Self

fn num_to_scalar_stage1(self) -> u64

fn num_to_vector_stage1(self) -> [u8; 16]

fn zigzag(from: Self::Signed) -> Self

fn unzigzag(self) -> Self::Signed

impl VarIntTarget for u64

const MAX_VARINT_BYTES: u8 = 10u8

const MAX_LAST_VARINT_BYTE: u8 = 1u8

type Signed = i64

fn scalar_to_num(_x: u64) -> Self

fn num_to_scalar_stage1(self) -> u64

fn vector_to_num(res: [u8; 16]) -> Self

fn num_to_vector_stage1(self) -> [u8; 16]

fn cast_u32(num: u32) -> Self

fn cast_u64(num: u64) -> Self

fn zigzag(from: Self::Signed) -> Self

fn unzigzag(self) -> Self::Signed

Implementors