ltk_meta 0.5.1

Metadata formats and utilities for League Toolkit
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

use crate::{
    property::{Kind, NoMeta},
    traits::{PropertyExt, PropertyValueExt, ReadProperty, WriteProperty},
};
use byteorder::LE;
use ltk_io_ext::{ReaderExt, WriterExt};

#[cfg_attr(
    feature = "serde",
    derive(serde::Serialize, serde::Deserialize),
    serde(bound = "for <'dee> M: serde::Serialize + serde::Deserialize<'dee>")
)]
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Default)]
pub struct String<M = NoMeta> {
    pub value: std::string::String,
    pub meta: M,
}

impl<M> String<M> {
    #[inline(always)]
    #[must_use]
    pub fn new(value: std::string::String) -> Self
    where
        M: Default,
    {
        Self::new_with_meta(value, M::default())
    }

    #[inline(always)]
    #[must_use]
    pub fn new_with_meta(value: std::string::String, meta: M) -> Self {
        Self { value, meta }
    }

    #[inline(always)]
    #[must_use]
    pub fn with_meta<T>(self, meta: T) -> String<T> {
        String {
            value: self.value,
            meta,
        }
    }

    #[inline(always)]
    #[must_use]
    pub fn no_meta(self) -> String<NoMeta> {
        self.with_meta(NoMeta)
    }
}

impl<M> PropertyValueExt for String<M> {
    const KIND: Kind = Kind::String;
}

impl<M> PropertyExt for String<M> {
    fn size_no_header(&self) -> usize {
        self.value.len() + 2
    }

    type Meta = M;
    fn meta(&self) -> &Self::Meta {
        &self.meta
    }
    fn meta_mut(&mut self) -> &mut Self::Meta {
        &mut self.meta
    }
}

impl<M: Default> ReadProperty for String<M> {
    fn from_reader<R: std::io::Read + std::io::Seek + ?Sized>(
        reader: &mut R,
        _legacy: bool,
    ) -> Result<Self, crate::Error> {
        Ok(Self {
            value: reader.read_sized_string_u16::<LE>()?,
            meta: M::default(),
        })
    }
}

impl<M> WriteProperty for String<M> {
    fn to_writer<R: std::io::Write + std::io::Seek + ?Sized>(
        &self,
        writer: &mut R,
        _legacy: bool,
    ) -> Result<(), std::io::Error> {
        writer.write_len_prefixed_string::<LE, _>(&self.value)
    }
}

impl<S: Into<std::string::String>, M: Default> From<S> for String<M> {
    fn from(value: S) -> Self {
        Self::new(value.into())
    }
}
impl<M> AsRef<std::string::String> for String<M> {
    fn as_ref(&self) -> &std::string::String {
        &self.value
    }
}

impl<M> std::ops::Deref for String<M> {
    type Target = std::string::String;

    fn deref(&self) -> &Self::Target {
        &self.value
    }
}