na_nbt 0.2.1

High-performance NBT (Named Binary Tag) library with zero-copy parsing and serde support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use crate::{
    CompoundMut, ConfigRef, GenericNBT, ListMut, MUTF8Str, NBT, ValueOwn, TagID, TypedListMut,
    ValueMut,
    tag::{
        Byte, ByteArray, Compound, Double, End, Float, Int, IntArray, List, Long, LongArray, Short,
        String,
    },
};

pub trait ConfigMut: ConfigRef {
    type ValueMut<'doc>: ValueMut<'doc, Config = Self>;
    type ListMut<'doc>: ListMut<'doc, Config = Self>;
    type ListIterMut<'doc>: Iterator<Item = Self::ValueMut<'doc>> + ExactSizeIterator + Default;
    type TypedListMut<'doc, T: NBT>: TypedListMut<'doc, T, Config = Self>;
    type TypedListIterMut<'doc, T: NBT>: Iterator<Item = T::TypeMut<'doc, Self>>
        + ExactSizeIterator
        + Default;
    type CompoundMut<'doc>: CompoundMut<'doc, Config = Self>;
    type CompoundIterMut<'doc>: Iterator<Item = (Self::String<'doc>, Self::ValueMut<'doc>)>
        + Default;

    type WriteParams<'a>: Sized;

    /// .
    ///
    /// # Safety
    ///
    /// .
    unsafe fn read_mut<'a, 'doc, T: GenericNBT>(
        params: Self::ReadParams<'a>,
    ) -> Option<T::TypeMut<'doc, Self>>;

    /// .
    ///
    /// # Safety
    ///
    /// .
    #[inline]
    #[allow(clippy::unit_arg)]
    unsafe fn read_value_mut<'a, 'doc>(
        tag_id: TagID,
        params: Self::ReadParams<'a>,
    ) -> Self::ValueMut<'doc> {
        unsafe {
            match tag_id {
                TagID::End => From::from(Self::read_mut::<End>(params).unwrap_unchecked()),
                TagID::Byte => From::from(Self::read_mut::<Byte>(params).unwrap_unchecked()),
                TagID::Short => From::from(Self::read_mut::<Short>(params).unwrap_unchecked()),
                TagID::Int => From::from(Self::read_mut::<Int>(params).unwrap_unchecked()),
                TagID::Long => From::from(Self::read_mut::<Long>(params).unwrap_unchecked()),
                TagID::Float => From::from(Self::read_mut::<Float>(params).unwrap_unchecked()),
                TagID::Double => From::from(Self::read_mut::<Double>(params).unwrap_unchecked()),
                TagID::ByteArray => {
                    From::from(Self::read_mut::<ByteArray>(params).unwrap_unchecked())
                }
                TagID::String => From::from(Self::read_mut::<String>(params).unwrap_unchecked()),
                TagID::List => From::from(Self::read_mut::<List>(params).unwrap_unchecked()),
                TagID::Compound => {
                    From::from(Self::read_mut::<Compound>(params).unwrap_unchecked())
                }
                TagID::IntArray => {
                    From::from(Self::read_mut::<IntArray>(params).unwrap_unchecked())
                }
                TagID::LongArray => {
                    From::from(Self::read_mut::<LongArray>(params).unwrap_unchecked())
                }
            }
        }
    }

    /// .
    ///
    /// # Safety
    ///
    /// Will NOT check if the value is of the correct type.
    unsafe fn list_push<'a, T: NBT>(params: Self::WriteParams<'a>, value: T::Type<Self::ByteOrder>);

    /// .
    ///
    /// # Safety
    ///
    /// Will NOT check bounds nor if the value is of the correct type.
    /// But will NOT pop and return None if T is TypedList and the type of the elements is not TypedList<N>
    unsafe fn list_pop<'a, T: GenericNBT>(
        params: Self::WriteParams<'a>,
    ) -> Option<T::Type<Self::ByteOrder>>;

    /// .
    ///
    /// # Safety
    ///
    /// Will NOT check bounds nor if the value is of the correct type.
    unsafe fn list_insert<'a, T: NBT>(
        params: Self::WriteParams<'a>,
        index: usize,
        value: T::Type<Self::ByteOrder>,
    );

    /// .
    ///
    /// # Safety
    ///
    /// Will NOT check bounds nor if the value is of the correct type.
    unsafe fn list_remove<'a, T: GenericNBT>(
        params: Self::WriteParams<'a>,
        index: usize,
    ) -> Option<T::Type<Self::ByteOrder>>;

    /// .
    ///
    /// # Safety
    ///
    /// Will NOT check if the key is already in the compound.
    /// NEED to call compound_remove first to check if the key is already in the compound.
    unsafe fn compound_insert<'a, T: GenericNBT>(
        params: Self::WriteParams<'a>,
        key: &MUTF8Str,
        value: T::Type<Self::ByteOrder>,
    );

    /// .
    ///
    /// # Safety
    ///
    /// .
    unsafe fn compound_remove<'a>(
        params: Self::WriteParams<'a>,
        key: &MUTF8Str,
    ) -> Option<ValueOwn<Self::ByteOrder>>;
}