Struct ghakuf::formats::VLQ

pub struct VLQ { /* fields omitted */ }

A struct representing SMF Variable Length Quantity.

You can make VLQ from u32 value.

Examples

use ghakuf::formats::VLQ;

let vlq = VLQ::new(192);
assert_eq!(vlq.val(), 192);
assert_eq!(vlq.binary(), [0x81, 0x40]);
assert_eq!(vlq.len(), 2);

Also you can make VLQ from u8 values.

Examples

use ghakuf::formats::{VLQ, VLQBuilder};

let vlq = VLQBuilder::new()
    .push(0x86)
    .push(0xc3)
    .push(0x17)
    .build();
assert_eq!(vlq.val(), 106_903);
assert_eq!(vlq.binary(), [0x86, 0xc3, 0x17]);
assert_eq!(vlq.len(), 3);

Note: Due to SMF restriction, this struct can only represent value under 2^28.

Implementations

impl VLQ

pub fn new(val: u32) -> VLQ

Builds VLQ from u32 value.

Examples

use ghakuf::formats::VLQ;

let vlq: VLQ = VLQ::new(192);

pub fn binary(&self) -> Vec<u8>

Makes binary array for SMF.

Examples

use ghakuf::formats::VLQ;

let vlq = VLQ::new(192);
assert_eq!(vlq.binary(), [0x81, 0x40]);

pub fn len(&self) -> usize

Returns length of binary array for SMF.

Examples

use ghakuf::formats::VLQ;

let vlq = VLQ::new(192);
assert_eq!(vlq.len(), 2);

pub fn val(&self) -> u32

Returns value from VLQ.

Examples

use ghakuf::formats::VLQ;

let vlq = VLQ::new(192);
assert_eq!(vlq.val(), 192);

Trait Implementations

impl Clone for VLQ

fn clone(&self) -> VLQ

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for VLQ

impl Debug for VLQ

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

Formats the value using the given formatter.

impl Display for VLQ

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

Formats the value using the given formatter.

impl PartialEq<VLQ> for VLQ

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

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

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

This method tests for !=.

impl StructuralPartialEq for VLQ