bin-proto 0.12.7

Conversion to/from binary for arbitrary types
Documentation
#![cfg(all(feature = "derive", feature = "alloc"))]

use std::marker::PhantomData;

use bin_proto::{BitDecode, BitDecodeExt, BitEncode, BitEncodeExt};
use bitstream_io::{BigEndian, BitRead, BitWrite, Endianness};

#[allow(unused)]
trait Boolean {
    fn set(&mut self);
}

impl Boolean for bool {
    fn set(&mut self) {
        *self = true
    }
}

#[allow(unused)]
trait TraitWithGeneric<'a, T>
where
    T: Boolean,
{
}

trait CtxTrait {
    fn call(&mut self);
}

#[derive(Debug)]
struct CtxStruct(bool);

impl CtxTrait for CtxStruct {
    fn call(&mut self) {
        self.0 = true
    }
}

#[derive(Debug)]
#[allow(unused)]
struct CtxStructWithGenerics<'a, T>(&'a mut T);

impl<'a, T> CtxTrait for CtxStructWithGenerics<'a, T>
where
    T: Boolean,
{
    fn call(&mut self) {
        self.0.set()
    }
}

#[derive(Debug)]
struct CtxCheck;

impl<Ctx: CtxTrait> BitDecode<Ctx> for CtxCheck {
    fn decode<R, E>(_: &mut R, ctx: &mut Ctx, _: ()) -> Result<Self, bin_proto::Error>
    where
        R: BitRead,
        E: Endianness,
    {
        ctx.call();
        Ok(Self)
    }
}

impl<Ctx: CtxTrait> BitEncode<Ctx> for CtxCheck {
    fn encode<W, E>(&self, _: &mut W, ctx: &mut Ctx, (): ()) -> Result<(), bin_proto::Error>
    where
        W: BitWrite,
        E: Endianness,
    {
        ctx.call();
        Ok(())
    }
}

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx = CtxStruct)]
struct CtxCheckStructWrapper(CtxCheck);

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx = CtxStructWithGenerics<'a, bool>, ctx_generics('a))]
#[allow(unused)]
struct CtxCheckStructWrapperWithGenericsConcreteBool(CtxCheck);

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx = CtxStructWithGenerics<'a, T>, ctx_generics('a, T: Boolean))]
#[allow(unused)]
struct CtxCheckStructWrapperWithGenerics(CtxCheck);

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx_bounds(TraitWithGeneric<'a, bool>, CtxTrait), ctx_generics('a))]
#[allow(unused)]
struct CtxCheckBoundsWithGenericsConcreteBool(CtxCheck);

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx_bounds(TraitWithGeneric<'a, T>, CtxTrait), ctx_generics('a))]
#[allow(unused)]
struct CtxCheckBoundsWithGenerics<T: Boolean>(CtxCheck, PhantomData<T>);

#[derive(Debug, BitDecode, BitEncode)]
#[bin_proto(ctx_bounds(CtxTrait))]
struct CtxCheckTraitWrapper(CtxCheck);

#[test]
fn decode_ctx_passed() {
    let mut ctx = CtxStruct(false);
    CtxCheck::decode_bytes_ctx(&[], BigEndian, &mut ctx, ()).unwrap();
    assert!(ctx.0);
}

#[test]
fn encode_ctx_passed() {
    let mut ctx = CtxStruct(false);
    CtxCheck.encode_bytes_ctx(BigEndian, &mut ctx, ()).unwrap();
    assert!(ctx.0);
}

#[test]
fn decode_ctx_passed_recur_struct() {
    let mut ctx = CtxStruct(false);
    CtxCheckStructWrapper(CtxCheck)
        .encode_bytes_ctx(BigEndian, &mut ctx, ())
        .unwrap();
    assert!(ctx.0);
}

#[test]
fn encode_ctx_passed_recur_struct() {
    let mut ctx = CtxStruct(false);
    CtxCheckStructWrapper(CtxCheck)
        .encode_bytes_ctx(BigEndian, &mut ctx, ())
        .unwrap();
    assert!(ctx.0);
}

#[test]
fn decode_ctx_passed_recur_trait() {
    let mut ctx = CtxStruct(false);
    CtxCheckTraitWrapper(CtxCheck)
        .encode_bytes_ctx(BigEndian, &mut ctx, ())
        .unwrap();
    assert!(ctx.0);
}

#[test]
fn encode_ctx_passed_recur_trait() {
    let mut ctx = CtxStruct(false);
    CtxCheckTraitWrapper(CtxCheck)
        .encode_bytes_ctx(BigEndian, &mut ctx, ())
        .unwrap();
    assert!(ctx.0);
}