nuts-bytes 0.7.9

Serialization into a binary data format
Documentation
// MIT License
//
// Copyright (c) 2023 Robin Doer
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

#![cfg(feature = "derive")]

mod common;

use nuts_bytes::{ToBytes, Writer};

use crate::common::{
    assert_sample_error, map_eq_mod, map_err_mod, map_err_to_bytes, map_mod, map_to_bytes,
};

#[test]
fn unit_struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample;

    let mut writer = Writer::new(vec![]);

    assert_eq!(writer.write(&Sample).unwrap(), 0);
    assert_eq!(writer.into_target(), []);
}

#[test]
fn empty_struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample {}

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample {}).unwrap(), 0);
    assert_eq!(writer.into_target(), []);
}

#[test]
fn empty_tuple_struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample();

    let mut writer = Writer::new(vec![]);

    assert_eq!(writer.write(&Sample {}).unwrap(), 0);
    assert_eq!(writer.into_target(), []);
}

#[test]
fn r#struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample {
        f1: u16,
        f2: u32,
        #[nuts_bytes(map = map_eq_mod)]
        f3: u8,
        #[nuts_bytes(map = map_mod)]
        f4: u8,
        #[nuts_bytes(map_to_bytes = map_to_bytes)]
        f5: u8,
        #[nuts_bytes(map = map_mod, map_to_bytes = map_to_bytes)]
        f6: u8,
        #[nuts_bytes(map_to_bytes = map_to_bytes, map = map_mod)]
        f7: u8,
        #[nuts_bytes(skip)]
        f8: u16,
    }

    let mut writer = Writer::new(vec![]);

    assert_eq!(
        writer
            .write(&Sample {
                f1: 1,
                f2: 2,
                f3: 3,
                f4: 4,
                f5: 5,
                f6: 6,
                f7: 7,
                f8: 8
            })
            .unwrap(),
        15
    );
    assert_eq!(
        writer.into_target(),
        [0, 1, 0, 0, 0, 2, 3, 0, 5, 0, 7, 0, 8, 0, 9]
    );
}

#[test]
fn r#struct_map_err() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample {
        f1: u16,
        #[nuts_bytes(map = map_err_mod)]
        f2: u32,
    }

    let mut writer = Writer::new(vec![]);

    let err = writer.write(&Sample { f1: 1, f2: 2 }).unwrap_err();
    assert_sample_error!(err);
}

#[test]
fn r#struct_map_to_bytes_err() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample {
        f1: u16,
        #[nuts_bytes(map_to_bytes = map_err_to_bytes)]
        f2: u32,
    }

    let mut writer = Writer::new(vec![]);

    let err = writer.write(&Sample { f1: 1, f2: 2 }).unwrap_err();
    assert_sample_error!(err);
}

#[test]
fn newtype_struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample(u16);

    let mut writer = Writer::new(vec![]);

    assert_eq!(writer.write(&Sample(1)).unwrap(), 2);
    assert_eq!(writer.into_target(), [0, 1]);
}

#[test]
fn tuple_struct() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample(
        u16,
        u32,
        #[nuts_bytes(map = map_eq_mod)] u8,
        #[nuts_bytes(map = map_mod)] u8,
        #[nuts_bytes(map_to_bytes = map_to_bytes)] u8,
        #[nuts_bytes(map = map_mod, map_to_bytes = map_to_bytes)] u8,
        #[nuts_bytes(map_to_bytes = map_to_bytes, map = map_mod)] u8,
        #[nuts_bytes(skip)] u16,
    );

    let mut writer = Writer::new(vec![]);

    assert_eq!(writer.write(&Sample(1, 2, 3, 4, 5, 6, 7, 8)).unwrap(), 15);
    assert_eq!(
        writer.into_target(),
        [0, 1, 0, 0, 0, 2, 3, 0, 5, 0, 7, 0, 8, 0, 9]
    );
}

#[test]
fn tuple_struct_map_err() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample(u16, #[nuts_bytes(map = map_err_mod)] u32);

    let mut writer = Writer::new(vec![]);

    let err = writer.write(&Sample(1, 2)).unwrap_err();
    assert_sample_error!(err);
}

#[test]
fn tuple_struct_map_to_bytes_err() {
    #[derive(Debug, PartialEq, ToBytes)]
    struct Sample(u16, #[nuts_bytes(map_to_bytes = map_err_to_bytes)] u32);

    let mut writer = Writer::new(vec![]);

    let err = writer.write(&Sample(1, 2)).unwrap_err();
    assert_sample_error!(err);
}

// #[test]
// fn zero_variant_enum() {
//     #[derive(ToBytes)]
//     enum Sample {}
//
//     // error: zero-variant enums cannot be instantiated
// }

#[test]
fn r#enum() {
    #[derive(Debug, PartialEq, ToBytes)]
    enum Sample {
        V0,
        V1 {},
        V2 { f1: u16 },
        V3 { f1: u16, f2: u32 },
        V4(),
        V5(u16),
        V6(u16, u32),
    }

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V0).unwrap(), 4);
    assert_eq!(writer.into_target(), [0, 0, 0, 0]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V1 {}).unwrap(), 4);
    assert_eq!(writer.into_target(), [0, 0, 0, 1]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V2 { f1: 1 }).unwrap(), 6);
    assert_eq!(writer.into_target(), [0, 0, 0, 2, 0, 1]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V3 { f1: 1, f2: 2 }).unwrap(), 10);
    assert_eq!(writer.into_target(), [0, 0, 0, 3, 0, 1, 0, 0, 0, 2]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V4()).unwrap(), 4);
    assert_eq!(writer.into_target(), [0, 0, 0, 4]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V5(1)).unwrap(), 6);
    assert_eq!(writer.into_target(), [0, 0, 0, 5, 0, 1]);

    let mut writer = Writer::new(vec![]);
    assert_eq!(writer.write(&Sample::V6(1, 2)).unwrap(), 10);
    assert_eq!(writer.into_target(), [0, 0, 0, 6, 0, 1, 0, 0, 0, 2]);
}