sval_flatten 2.19.0

use crate::{
    flattener::{Flatten, Flattener},
    label::LabelBuf,
};
use sval::{Index, Label, Stream, Tag};

/**
Flatten the fields of a value onto a record or tuple.

The `offset` is the current length of the record or tuple. A new offset will be returned
with the length of the record or tuple after flattening the value.
 */
pub fn flatten_to_record_tuple<'sval>(
    stream: &mut (impl Stream<'sval> + ?Sized),
    value: &'sval (impl sval::Value + ?Sized),
    offset: isize,
) -> sval::Result<isize> {
    let mut stream = FlattenToRecordTuple::new(stream, offset);

    value.stream(&mut stream)?;

    Ok(stream.end().0)
}

/**
A stream that flattens the fields of a value onto a record or tuple.
*/
pub struct FlattenToRecordTuple<'sval, S> {
    inner: Flattener<'sval, RecordTupleFlatten<'sval, S>>,
}

impl<'sval, S: sval::Stream<'sval>> FlattenToRecordTuple<'sval, S> {
    /**
    Wrap the given `stream`.

    The `offset` is the current length of the record or tuple being flattened onto.
    Call [`FlattenToRecordTuple::end`] after streaming a value to get the new length of the record or tuple.
    */
    pub fn new(stream: S, offset: isize) -> Self {
        let label_stream = LabelBuf::default();

        FlattenToRecordTuple {
            inner: Flattener::begin(
                RecordTupleFlatten {
                    stream,
                    label_stream,
                },
                offset,
            ),
        }
    }

    /**
    Finish flattening a value.

    This method returns the length of the map after flattening that can be used to reconstruct a `FlattenToRecordTuple` for a future value.
    */
    pub fn end(self) -> (isize, S) {
        let (offset, RecordTupleFlatten { stream, .. }) = self.inner.end();

        (offset, stream)
    }
}

impl_stream_forward!({ impl<'sval, S: Stream<'sval>> Stream<'sval> for FlattenToRecordTuple<'sval, S> } => x => { x.inner });

struct RecordTupleFlatten<'sval, S> {
    stream: S,
    label_stream: LabelBuf<'sval>,
}

impl<'sval, S: Stream<'sval>> Flatten<'sval> for RecordTupleFlatten<'sval, S> {
    type Stream = S;
    type LabelStream = LabelBuf<'sval>;

    fn stream(&mut self) -> &mut Self::Stream {
        &mut self.stream
    }

    fn label_stream(&mut self) -> &mut Self::LabelStream {
        &mut self.label_stream
    }

    fn flattened_value_begin(
        &mut self,
        tag: Option<&Tag>,
        label: &Label,
        index: &Index,
    ) -> sval::Result {
        self.stream.record_tuple_value_begin(tag, label, index)
    }

    fn flattened_value_end(
        &mut self,
        tag: Option<&Tag>,
        label: &Label,
        index: &Index,
    ) -> sval::Result {
        self.stream.record_tuple_value_end(tag, label, index)
    }
}

#[cfg(test)]
mod tests {
    use sval_derive_macros::*;

    use super::*;

    struct Outer<I> {
        a: i32,
        // #[sval(flatten)]
        i: I,
        d: i32,
    }

    impl<I: sval::Value> sval::Value for Outer<I> {
        fn stream<'sval, S: Stream<'sval> + ?Sized>(&'sval self, stream: &mut S) -> sval::Result {
            let mut offset = 0;

            stream.record_tuple_begin(None, Some(&Label::new("Outer")), None, None)?;

            stream.record_tuple_value_begin(
                None,
                &Label::new("a"),
                &Index::from(offset).with_tag(&sval::tags::VALUE_OFFSET),
            )?;
            stream.i32(self.a)?;
            stream.record_tuple_value_end(
                None,
                &Label::new("a"),
                &Index::from(offset).with_tag(&sval::tags::VALUE_OFFSET),
            )?;
            offset += 1;

            offset = flatten_to_record_tuple(&mut *stream, &self.i, offset)?;

            stream.record_tuple_value_begin(
                None,
                &Label::new("d"),
                &Index::from(offset).with_tag(&sval::tags::VALUE_OFFSET),
            )?;
            stream.i32(self.d)?;
            stream.record_tuple_value_end(
                None,
                &Label::new("d"),
                &Index::from(offset).with_tag(&sval::tags::VALUE_OFFSET),
            )?;
            offset += 1;

            let _ = offset;
            stream.record_tuple_end(None, Some(&Label::new("Outer")), None)
        }
    }

    struct AllFlattened<A, B, C> {
        a: A,
        b: B,
        c: C,
    }

    impl<A: sval::Value, B: sval::Value, C: sval::Value> sval::Value for AllFlattened<A, B, C> {
        fn stream<'sval, S: Stream<'sval> + ?Sized>(&'sval self, stream: &mut S) -> sval::Result {
            let mut offset = 0;

            stream.record_tuple_begin(None, Some(&Label::new("Outer")), None, None)?;

            offset = flatten_to_record_tuple(&mut *stream, &self.a, offset)?;
            offset = flatten_to_record_tuple(&mut *stream, &self.b, offset)?;
            offset = flatten_to_record_tuple(&mut *stream, &self.c, offset)?;

            let _ = offset;
            stream.record_tuple_end(None, Some(&Label::new("Outer")), None)
        }
    }

    #[test]
    fn flatten_record() {
        #[derive(Value)]
        #[sval(unindexed_fields)]
        struct Inner {
            b: i32,
            c: i32,
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner { b: 2, c: 3 },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_tuple() {
        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: (2, 3),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("1"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("1"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("2"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("2"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_seq() {
        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: [2, 3],
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("1"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("1"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("2"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("2"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_map() {
        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: sval::MapSlice::new(&[("b", 2), ("c", 3)]),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_record_tuple() {
        #[derive(Value)]
        struct Inner {
            b: i32,
            c: i32,
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner { b: 2, c: 3 },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_enum() {
        #[derive(Value)]
        enum Inner {
            #[sval(label = "b")]
            A(i32),
            B {
                b: i32,
                c: i32,
            },
            C(i32, i32),
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner::A(2),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(2)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(2)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner::B { b: 2, c: 3 },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner::C(2, 3),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("1"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("1"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("2"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("2"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_nested_enum() {
        #[derive(Value)]
        struct Inner {
            b: ReallyInner,
        }

        #[derive(Value)]
        struct ReallyInner {
            b1: ReallyReallyInner,
        }

        #[derive(Value)]
        #[allow(dead_code)]
        enum ReallyReallyInner {
            #[sval(label = "b")]
            A(i32),
            B {
                b: i32,
                c: i32,
            },
            C(i32, i32),
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner {
                    b: ReallyInner {
                        b1: ReallyReallyInner::B { b: 42, c: 43 },
                    },
                },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    RecordTupleBegin(None, Some(Label::new("ReallyInner")), None, Some(1)),
                    RecordTupleValueBegin(None, Label::new("b1"), Index::new(0)),
                    EnumBegin(None, Some(Label::new("ReallyReallyInner")), None),
                    RecordTupleBegin(None, Some(Label::new("B")), Some(Index::new(1)), Some(2)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(0)),
                    I32(42),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(1)),
                    I32(43),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("B")), Some(Index::new(1))),
                    EnumEnd(None, Some(Label::new("ReallyReallyInner")), None),
                    RecordTupleValueEnd(None, Label::new("b1"), Index::new(0)),
                    RecordTupleEnd(None, Some(Label::new("ReallyInner")), None),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(2)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(2)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_nested() {
        #[derive(Value)]
        struct Inner {
            b: ReallyInner,
            c: ReallyInner,
        }

        #[derive(Value)]
        struct ReallyInner {
            b1: i32,
            b2: i32,
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner {
                    b: ReallyInner { b1: 21, b2: 22 },
                    c: ReallyInner { b1: 31, b2: 32 },
                },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    RecordTupleBegin(None, Some(Label::new("ReallyInner")), None, Some(2)),
                    RecordTupleValueBegin(None, Label::new("b1"), Index::new(0)),
                    I32(21),
                    RecordTupleValueEnd(None, Label::new("b1"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b2"), Index::new(1)),
                    I32(22),
                    RecordTupleValueEnd(None, Label::new("b2"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("ReallyInner")), None),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    RecordTupleBegin(None, Some(Label::new("ReallyInner")), None, Some(2)),
                    RecordTupleValueBegin(None, Label::new("b1"), Index::new(0)),
                    I32(31),
                    RecordTupleValueEnd(None, Label::new("b1"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b2"), Index::new(1)),
                    I32(32),
                    RecordTupleValueEnd(None, Label::new("b2"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("ReallyInner")), None),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_siblings() {
        #[derive(Value)]
        struct A {
            a: i32,
        }

        #[derive(Value)]
        struct B {
            b: i32,
        }

        #[derive(Value)]
        struct C {
            c: i32,
        }

        sval_test::assert_tokens(
            &AllFlattened {
                a: A { a: 1 },
                b: B { b: 2 },
                c: C { c: 3 },
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(2)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_siblings_exotic_explicit_indexes() {
        #[derive(Value)]
        struct A {
            #[sval(index = -4)]
            a: i32,
        }

        #[derive(Value)]
        struct B {
            b: i32,
        }

        #[derive(Value)]
        struct C {
            c: i32,
        }

        sval_test::assert_tokens(
            &AllFlattened {
                a: A { a: 1 },
                b: B { b: 2 },
                c: C { c: 3 },
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::from(-4)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::from(-4)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::from(-3)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::from(-3)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::from(-2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::from(-2)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    #[cfg(feature = "alloc")]
    fn flatten_map_complex() {
        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: sval::MapSlice::new(&[(["b1", "b2"], 2), (["c1", "c2"], 3)]),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b1b2"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b1b2"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("c1c2"), Index::new(2)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c1c2"), Index::new(2)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(3)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(3)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_enum_tag() {
        #[derive(Value)]
        enum Inner {
            A,
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner::A,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_exotic_tuple_explicit_indexes() {
        #[derive(Value)]
        struct Inner(#[sval(index = 3)] i32, #[sval(index = 4)] i32);

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner(2, 3),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("3"), Index::new(3)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("3"), Index::new(3)),
                    RecordTupleValueBegin(None, Label::new("4"), Index::new(4)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("4"), Index::new(4)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(5)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(5)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_exotic_enum_explicit_indexes() {
        #[derive(Value)]
        enum Inner {
            B {
                #[sval(index = 4)]
                b: i32,
                #[sval(index = 6)]
                c: i32,
            },
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: Inner::B { b: 2, c: 3 },
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("b"), Index::new(4)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("b"), Index::new(4)),
                    RecordTupleValueBegin(None, Label::new("c"), Index::new(6)),
                    I32(3),
                    RecordTupleValueEnd(None, Label::new("c"), Index::new(6)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(7)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(7)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_exotic_nested_enum() {
        struct NestedEnum;

        impl sval::Value for NestedEnum {
            fn stream<'sval, S: sval::Stream<'sval> + ?Sized>(
                &'sval self,
                stream: &mut S,
            ) -> sval::Result {
                stream.enum_begin(None, Some(&Label::new("Enum")), None)?;

                stream.enum_begin(
                    None,
                    Some(&Label::new("EnumInner")),
                    Some(&Index::new(7).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.tuple_begin(
                    None,
                    Some(&Label::new("EnumInnerValue")),
                    Some(&Index::new(0).with_tag(&sval::tags::VALUE_OFFSET)),
                    Some(1),
                )?;

                stream
                    .tuple_value_begin(None, &Index::new(0).with_tag(&sval::tags::VALUE_OFFSET))?;
                stream.i32(2)?;
                stream.tuple_value_end(None, &Index::new(0).with_tag(&sval::tags::VALUE_OFFSET))?;

                stream.tuple_end(
                    None,
                    Some(&Label::new("EnumInnerValue")),
                    Some(&Index::new(0).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_end(
                    None,
                    Some(&Label::new("EnumInner")),
                    Some(&Index::new(7).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_end(None, Some(&Label::new("Enum")), None)
            }
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: NestedEnum,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("1"), Index::new(1)),
                    I32(2),
                    RecordTupleValueEnd(None, Label::new("1"), Index::new(1)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(2)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(2)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_exotic_enum_empty() {
        struct EmptyEnum;

        impl sval::Value for EmptyEnum {
            fn stream<'sval, S: sval::Stream<'sval> + ?Sized>(
                &'sval self,
                stream: &mut S,
            ) -> sval::Result {
                stream.enum_begin(None, Some(&Label::new("Enum")), None)?;
                stream.enum_end(None, Some(&Label::new("Enum")), None)
            }
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: EmptyEnum,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_exotic_enum_nested_empty() {
        struct NestedEnum;

        impl sval::Value for NestedEnum {
            fn stream<'sval, S: sval::Stream<'sval> + ?Sized>(
                &'sval self,
                stream: &mut S,
            ) -> sval::Result {
                stream.enum_begin(None, Some(&Label::new("Enum")), None)?;

                stream.enum_begin(
                    None,
                    Some(&Label::new("EnumInner")),
                    Some(&Index::new(7).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_begin(
                    None,
                    Some(&Label::new("EnumInnerInner")),
                    Some(&Index::new(3).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_end(
                    None,
                    Some(&Label::new("EnumInnerInner")),
                    Some(&Index::new(3).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_end(
                    None,
                    Some(&Label::new("EnumInner")),
                    Some(&Index::new(7).with_tag(&sval::tags::VALUE_OFFSET)),
                )?;

                stream.enum_end(None, Some(&Label::new("Enum")), None)
            }
        }

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: NestedEnum,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }

    #[test]
    fn flatten_primitive() {
        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: 1u128,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: -1i128,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: 3.14f64,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: true,
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: "Text",
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );

        sval_test::assert_tokens(
            &Outer {
                a: 1,
                i: sval::BinarySlice::new(b"Binary"),
                d: 4,
            },
            {
                use sval_test::Token::*;

                &[
                    RecordTupleBegin(None, Some(Label::new("Outer")), None, None),
                    RecordTupleValueBegin(None, Label::new("a"), Index::new(0)),
                    I32(1),
                    RecordTupleValueEnd(None, Label::new("a"), Index::new(0)),
                    RecordTupleValueBegin(None, Label::new("d"), Index::new(1)),
                    I32(4),
                    RecordTupleValueEnd(None, Label::new("d"), Index::new(1)),
                    RecordTupleEnd(None, Some(Label::new("Outer")), None),
                ]
            },
        );
    }
}