Struct binary_tuples::Tuple

pub struct Tuple { /* fields omitted */ }

A builder for serialized tuples

Methods

impl Tuple

pub fn new() -> Tuple

Create a new tuple

pub fn with_capacity(capacity: usize) -> Tuple

Create a new tuple with a fixed backing capacity

pub fn from_bytes(bytes: &[u8]) -> Tuple

Create a new tuple from an existing byte array

This can be used with as_segments to parse an existing tuple into a list of segments

Examples

use binary_tuples::{Tuple, segment::Segment};

let binary = vec![2, 117, 115, 101, 114, 115, 0, 21, 1];

let tuple = Tuple::from_bytes(&binary)
    .as_segments()
    .unwrap();

assert_eq!(tuple, vec![Segment::String(String::from("users")), Segment::Integer(1)]);

pub fn add_segment(&mut self, input: &Segment)

Add an individual segment to this tuple.

Notes

It is recommended to import AddToTuple as it greatly simplifies this API

pub fn add_builder(&mut self, input: &Tuple)

Directly embed the contents of another tuple builder in this builder

Notes

This is more efficient than adding a segment slice as the backing buffer can be memcopied.

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

Return a serialized tuple

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

Return a serialized tuple

pub fn as_segments(&self) -> Result<Vec<Segment>, TupleError>

Deserialize the segments which make up this tuple

Trait Implementations

impl Clone for Tuple

fn clone(&self) -> Tuple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AddToTuple<i64> for Tuple

fn add(&mut self, v: i64)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<String> for Tuple

fn add(&mut self, v: String)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl<'a> AddToTuple<&'a [u8]> for Tuple

fn add(&mut self, v: &'a [u8])

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl<'a> AddToTuple<&'a Vec<u8>> for Tuple

fn add(&mut self, v: &'a Vec<u8>)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<f32> for Tuple

fn add(&mut self, v: f32)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<f64> for Tuple

fn add(&mut self, v: f64)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<Vec<u8>> for Tuple

fn add(&mut self, v: Vec<u8>)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<&'static str> for Tuple

fn add(&mut self, v: &'static str)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<Uuid> for Tuple

fn add(&mut self, v: Uuid)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<Vec<Segment>> for Tuple

fn add(&mut self, v: Vec<Segment>)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl<'a> AddToTuple<&'a Tuple> for Tuple

fn add(&mut self, v: &'a Tuple)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple

impl AddToTuple<Tuple> for Tuple

fn add(&mut self, v: Tuple)

Add a new segment to a tuple

fn with(self, input: T) -> Self

A fluent interface for adding a new segment to a tuple