Struct Buffer 

pub struct Buffer { /* private fields */ }

The Buffer struct is used to read and write Buffer messages.

Description

This works as a wrapper around a byte buffer. The idea is to have an opinionated reading/writing API for little-endian encodings for various signed and unsigned integer types. It also includes basic varint encoding and decoding.

Usage

Create a new Buffer instance:

use gistools::util::Buffer;

let mut buf = Buffer::new();

Create a Buffer instance from a byte buffer:

use gistools::util::Buffer;

let mut vec = vec![0x0A, 0x03, 0x74, 0x65, 0x73, 0x74];
let mut buf = Buffer::new(vec);
// DO STUFF
let res = buf.take();

Implementations

impl Buffer

pub fn new(buf: Vec<u8>) -> Buffer

Create a new Buffer instance.

pub fn buf(&self) -> &[u8]

See the contents of the buffer

pub fn pos(&self) -> usize

Get the position to read from the buffer next.

pub fn set_pos(&mut self, pos: usize)

Set the position to read from the buffer next.

pub fn len(&self) -> usize

get the length of the bufer

pub fn is_empty(&self) -> bool

check if the buffer is empty

pub fn get_u8(&mut self) -> u8

return the current u8 under the buffer

pub fn get_u8_at(&mut self, pos: usize) -> u8

return the current u8 at position

pub fn set_u8(&mut self, value: u8)

set the current u8 under the buffer

pub fn set_u8_at(&mut self, pos: usize, value: u8)

set the current u8 at position

pub fn get_i8(&mut self) -> i8

return the current i8 under the buffer

pub fn get_i8_at(&mut self, pos: usize) -> i8

return the current i8 at position

pub fn set_i8(&mut self, value: i8)

set the current u8 under the buffer

pub fn set_i8_at(&mut self, pos: usize, value: i8)

set the current i8 at position

pub fn get_i32(&mut self) -> i32

return the current i32 under the buffer

pub fn get_i32_at(&mut self, pos: usize) -> i32

return the current i32 at position

pub fn set_i32(&mut self, value: i32)

set the current i32 under the buffer

pub fn set_i32_at(&mut self, pos: usize, value: i32)

set the current i32 at position

pub fn get_u16(&mut self) -> u16

return the current u16 under the buffer

pub fn get_u16_at(&mut self, pos: usize) -> u16

return the current u16 at position

pub fn set_u16(&mut self, value: u16)

set the current u16 under the buffer

pub fn set_u16_at(&mut self, pos: usize, value: u16)

set the current u16 at position

pub fn get_i16(&mut self) -> i16

return the current i16 under the buffer

pub fn get_i16_at(&mut self, pos: usize) -> i16

return the current i16 at position

pub fn set_i16(&mut self, value: i16)

set the current i16 under the buffer

pub fn set_i16_at(&mut self, pos: usize, value: i16)

set the current i16 at position

pub fn get_u32(&mut self) -> u32

return the current u32 under the buffer

pub fn get_u32_at(&mut self, pos: usize) -> u32

return the current u32 at position

pub fn set_u32(&mut self, value: u32)

set the current u32 under the buffer

pub fn set_u32_at(&mut self, pos: usize, value: u32)

set the current u32 at position

pub fn get_f32(&mut self) -> f32

Return the current f32 at position

pub fn get_f32_at(&mut self, pos: usize) -> f32

Return the current f32 at position

pub fn set_f32(&mut self, value: f32)

Set the current f32 at position

pub fn set_f32_at(&mut self, pos: usize, value: f32)

Set the current f32 at position

pub fn get_i64(&mut self) -> i64

return the current i32 under the buffer

pub fn get_i64_at(&mut self, pos: usize) -> i64

return the current i32 at position

pub fn set_i64(&mut self, value: i64)

set the current i32 under the buffer

pub fn set_i64_at(&mut self, pos: usize, value: i64)

set the current i32 at position

pub fn get_u64(&mut self) -> u64

return the current u64 under the buffer

pub fn get_u64_at(&mut self, pos: usize) -> u64

return the current u64 at position

pub fn set_u64(&mut self, value: u64)

set the current u64 under the buffer

pub fn set_u64_at(&mut self, pos: usize, value: u64)

set the current u64 at position

pub fn get_f64(&mut self) -> f64

Return the current f64 at position

pub fn get_f64_at(&mut self, pos: usize) -> f64

Return the current f64 at position

pub fn set_f64(&mut self, value: f64)

Set the current f64 at position

pub fn set_f64_at(&mut self, pos: usize, value: f64)

Set the current f64 at position

pub fn decode_varint(&mut self) -> u64

Decode a varint from the buffer at the current position.

pub fn read_varint<T>(&mut self) -> T

where T: BitCast,

Read in a variable size value from the buffer.

pub fn write_varint<T>(&mut self, val: T)

where T: BitCast,

Write a u64 to the buffer.

pub fn take(&mut self) -> Vec<u8>

When done writing to the buffer, call this function to take ownership

pub fn copy_from_slice(&mut self, offset: usize, slice: &[u8])

Copy a slice into the buffer

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Buffer

Returns the “default value” for a type.

impl From<Vec<u8>> for Buffer

fn from(buf: Vec<u8>) -> Buffer

Converts to this type from the input type.

impl PartialEq for Buffer

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Buffer