exolvl 0.12.0

A library for reading and writing Exoracer level files.
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

//! A collection of traits that allow for reading and writing values in the binary format.

use crate::{error::Error, private};

/// A trait for reading values from a binary exolvl file.
///
/// # Sealed
///
/// This trait is sealed and cannot be implemented for types outside of this crate.
pub trait Read: private::Sealed {
    /// Reads a value from the given input.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying reader returns an error.
    fn read(input: &mut impl std::io::Read) -> Result<Self, Error>
    where
        Self: Sized;
}

/// A trait to allow reading values from a binary exolvl file while adhering to a specific version of the format.
///
/// This allows reading old files while also supporting new features.
///
/// # Sealed
///
/// This trait is sealed and cannot be implemented for types outside of this crate.
pub trait ReadVersioned: private::Sealed {
    /// Reads a value from a given output. This method takes an additional parameter of type [`i32`] which describes the level format version.
    ///
    /// This method should almost never be called by outside users of the library. Use [`Read`] instead. If you *need* to use this method, take special care to pass the correct version for the specific level file you're using.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying reader returns an error.
    fn read(input: &mut impl std::io::Read, version: i32) -> Result<Self, Error>
    where
        Self: Sized;
}

/// A trait for reading values from a binary exolvl file with additional context.
///
/// This trait is similar to [`Read`], but takes an additional generic parameter. This is sometimes necessary for reading enums.
///
/// # Sealed
///
/// This trait is sealed and cannot be implemented for types outside of this crate.
pub trait ReadContext: private::Sealed {
    /// Additional context to pass to `read_ctx`.
    type Context;

    /// Reads a value from a given output. This method takes an additional parameter as context.
    ///
    /// This method should almost never be called by outside users of the library. Use [`Read`] instead.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying reader returns an error.
    fn read_ctx(input: &mut impl std::io::Read, with: Self::Context) -> Result<Self, Error>
    where
        Self: Sized;
}

/// A trait for writing values to a binary exolvl file.
///
/// # Sealed
///
/// This trait is sealed and cannot be implemented for types outside of this crate.
pub trait Write: private::Sealed {
    /// Writes a value to a given output.
    ///
    /// # Errors
    ///
    /// Returns an error if the underlying writer returns an error.
    fn write(&self, output: &mut impl std::io::Write) -> Result<(), Error>;
}