celeste_rs 0.5.1

Library for working with files related to Celeste and it's modding scene.
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

use crate::maps::{
    var_types::EncodedVar,
    ErasedMapElement,
    LookupTable,
    MapAttribute,
    RawMapElement,
    ResolvableString,
};

pub struct MapEncoder<'a> {
    pub lookup: &'a mut LookupTable,
    pub(crate) element_name: ResolvableString,
    pub(crate) children: Vec<RawMapElement>,
    pub(crate) attrs: Vec<MapAttribute>,
}

impl<'a> MapEncoder<'a> {
    /// Sets the name of the raw element
    ///
    /// This is already done when creating the [MapEncoder] so this
    /// is only needed when [MapElement::NAME](crate::maps::MapElement::NAME) is incorrect
    pub fn name(&mut self, name: impl AsRef<str>) {
        self.element_name = self.lookup.index_string(name);
    }

    /// Pushes a new [MapAttribute] onto the raw element
    pub fn attribute(&mut self, name: impl AsRef<str>, value: impl Into<EncodedVar>) {
        self.attrs
            .push(MapAttribute::new(self.lookup.index_string(name), value))
    }

    /// Pushes a new [MapAttribute] onto the raw element if the option value is `Some`
    pub fn optional_attribute<'c, T: Into<EncodedVar> + Clone + 'c>(
        &mut self,
        name: impl AsRef<str>,
        value: &Option<T>,
    ) {
        if let Some(t) = value {
            self.attribute(name, t.clone())
        }
    }

    /// Pushes a new child [MapElement](crate::maps::MapElement) onto the raw element
    pub fn child<T: ErasedMapElement>(&mut self, child: &T) {
        let child_name = self.lookup.index_string(child.name());
        let mut fork = self.fork(child_name);

        child.to_raw(&mut fork);

        let child = fork.resolve();

        self.children.push(child);
    }

    /// Pushes all the [MapElement](crate::maps::MapElement)s in the list as children on the raw elements
    pub fn children<T: ErasedMapElement>(&mut self, children: impl AsRef<[T]>) {
        let children = children.as_ref();

        for child in children {
            self.child(child)
        }
    }

    /// Forks the current encoder to create a new [RawMapElement]
    #[doc(hidden)]
    pub fn fork(&mut self, name: ResolvableString) -> MapEncoder {
        MapEncoder {
            lookup: self.lookup,
            element_name: name,
            children: Vec::new(),
            attrs: Vec::new(),
        }
    }

    /// Consumes the [MapEncoder] converting it into a [RawMapElement]
    pub fn resolve(self) -> RawMapElement {
        RawMapElement {
            name: self.element_name,
            attributes: self.attrs,
            children: self.children,
        }
    }

    /// Loads data from an existing [RawMapElement]
    #[doc(hidden)]
    pub fn from_raw(&mut self, raw: &RawMapElement) {
        self.element_name = raw.name.clone();
        self.attrs.clone_from(&raw.attributes);
        self.children.clone_from(&raw.children);
    }
}