Struct BinaryBuffer 

pub struct BinaryBuffer<T>(/* private fields */);

Implementations

impl BinaryBuffer<Vec<u8>>

pub fn new() -> Self

pub fn with_capacity(capacity: usize) -> Self

pub fn into_inner(self) -> Vec<u8>

impl<T: AsRef<[u8]>> BinaryBuffer<T>

pub fn from_data(data: T) -> Self

pub fn read_string(&mut self) -> Result<String>

pub fn read_nullable_string(&mut self) -> Result<Option<String>>

pub fn read_json<V: DeserializeOwned>(&mut self) -> Result<V>

impl BinaryBuffer<Vec<u8>>

pub fn write_string(&mut self, text: &str) -> Result<()>

pub fn write_nullable_string(&mut self, text: Option<&str>) -> Result<()>

pub fn write_json<V: Serialize>(&mut self, value: &V) -> Result<()>

Methods from Deref<Target = Cursor<T>>

pub fn get_ref(&self) -> &T

Gets a reference to the underlying value in this cursor.

Examples

use std::io::Cursor;

let buff = Cursor::new(Vec::new());

let reference = buff.get_ref();

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the underlying value in this cursor.

Care should be taken to avoid modifying the internal I/O state of the underlying value as it may corrupt this cursor’s position.

Examples

use std::io::Cursor;

let mut buff = Cursor::new(Vec::new());

let reference = buff.get_mut();

pub fn position(&self) -> u64

Returns the current position of this cursor.

Examples

use std::io::Cursor;
use std::io::prelude::*;
use std::io::SeekFrom;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.position(), 0);

buff.seek(SeekFrom::Current(2)).unwrap();
assert_eq!(buff.position(), 2);

buff.seek(SeekFrom::Current(-1)).unwrap();
assert_eq!(buff.position(), 1);

pub fn set_position(&mut self, pos: u64)

Sets the position of this cursor.

Examples

use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.position(), 0);

buff.set_position(2);
assert_eq!(buff.position(), 2);

buff.set_position(4);
assert_eq!(buff.position(), 4);

pub fn split(&self) -> (&[u8], &[u8])

🔬This is a nightly-only experimental API. (cursor_split)

Splits the underlying slice at the cursor position and returns them.

Examples

#![feature(cursor_split)]
use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.split(), ([].as_slice(), [1, 2, 3, 4, 5].as_slice()));

buff.set_position(2);
assert_eq!(buff.split(), ([1, 2].as_slice(), [3, 4, 5].as_slice()));

buff.set_position(6);
assert_eq!(buff.split(), ([1, 2, 3, 4, 5].as_slice(), [].as_slice()));

pub fn split_mut(&mut self) -> (&mut [u8], &mut [u8])

🔬This is a nightly-only experimental API. (cursor_split)

Splits the underlying slice at the cursor position and returns them mutably.

Examples

#![feature(cursor_split)]
use std::io::Cursor;

let mut buff = Cursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.split_mut(), ([].as_mut_slice(), [1, 2, 3, 4, 5].as_mut_slice()));

buff.set_position(2);
assert_eq!(buff.split_mut(), ([1, 2].as_mut_slice(), [3, 4, 5].as_mut_slice()));

buff.set_position(6);
assert_eq!(buff.split_mut(), ([1, 2, 3, 4, 5].as_mut_slice(), [].as_mut_slice()));

Trait Implementations

impl Default for BinaryBuffer<Vec<u8>>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for BinaryBuffer<T>

type Target = Cursor<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for BinaryBuffer<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.