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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
use std::io::{
Read,
Write,
};
use bevy::prelude::*;
use crate::{
erased_serde::Error,
prelude::*,
};
// Writer |------------------------------------------------------------------------------------------------------------
/// A borrowed or owned writer.
pub enum Writer<'w> {
/// Borrowed variant.
Borrowed(&'w mut dyn Write),
/// Owned variant.
Owned(Box<dyn Write + 'w>),
}
impl<'w, W: Write> From<&'w mut W> for Writer<'w> {
fn from(value: &'w mut W) -> Self {
Self::Borrowed(value)
}
}
impl<'w, W: Write + 'w> From<Box<W>> for Writer<'w> {
fn from(value: Box<W>) -> Self {
Self::Owned(value)
}
}
impl<'w> std::ops::Deref for Writer<'w> {
type Target = dyn Write + 'w;
fn deref(&self) -> &Self::Target {
match self {
Self::Borrowed(wr) => wr,
Self::Owned(wr) => wr,
}
}
}
impl<'w> std::ops::DerefMut for Writer<'w> {
fn deref_mut(&mut self) -> &mut Self::Target {
match self {
Self::Borrowed(wr) => wr,
Self::Owned(wr) => wr,
}
}
}
impl<'w> std::io::Write for Writer<'w> {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
(**self).write(buf)
}
fn flush(&mut self) -> std::io::Result<()> {
(**self).flush()
}
fn write_vectored(&mut self, bufs: &[std::io::IoSlice<'_>]) -> std::io::Result<usize> {
(**self).write_vectored(bufs)
}
fn write_all(&mut self, buf: &[u8]) -> std::io::Result<()> {
(**self).write_all(buf)
}
fn write_fmt(&mut self, fmt: std::fmt::Arguments<'_>) -> std::io::Result<()> {
(**self).write_fmt(fmt)
}
}
/// An owned [`Writer`].
pub type OwnedWriter = Writer<'static>;
// Reader |------------------------------------------------------------------------------------------------------------
/// A borrowed or owned reader.
pub enum Reader<'r> {
/// Borrowed variant.
Borrowed(&'r mut dyn Read),
/// Owned variant.
Owned(Box<dyn Read + 'r>),
}
impl<'r, R: Read> From<&'r mut R> for Reader<'r> {
fn from(value: &'r mut R) -> Self {
Self::Borrowed(value)
}
}
impl<'r, R: Read + 'r> From<Box<R>> for Reader<'r> {
fn from(value: Box<R>) -> Self {
Self::Owned(value)
}
}
impl<'r> std::ops::Deref for Reader<'r> {
type Target = dyn Read + 'r;
fn deref(&self) -> &Self::Target {
match self {
Self::Borrowed(re) => re,
Self::Owned(re) => re,
}
}
}
impl<'r> std::ops::DerefMut for Reader<'r> {
fn deref_mut(&mut self) -> &mut Self::Target {
match self {
Self::Borrowed(re) => re,
Self::Owned(re) => re,
}
}
}
impl<'r> std::io::Read for Reader<'r> {
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
(**self).read(buf)
}
fn read_vectored(&mut self, bufs: &mut [std::io::IoSliceMut<'_>]) -> std::io::Result<usize> {
(**self).read_vectored(bufs)
}
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> std::io::Result<usize> {
(**self).read_to_end(buf)
}
fn read_to_string(&mut self, buf: &mut String) -> std::io::Result<usize> {
(**self).read_to_string(buf)
}
fn read_exact(&mut self, buf: &mut [u8]) -> std::io::Result<()> {
(**self).read_exact(buf)
}
}
/// An owned [`Reader`].
pub type OwnedReader = Reader<'static>;
// Saver / Loader |----------------------------------------------------------------------------------------------------
/// Handles serialization of save data.
///
/// Use [`AppSaver`] to override the [`Saver`] that `bevy_save` uses for saving snapshots.
pub trait Saver: Send + Sync + 'static {
/// Build a serializer trait object from the given writer.
///
/// # Example
/// ```
/// # use bevy_save::prelude::*;
/// pub struct RMPSaver;
///
/// impl Saver for RMPSaver {
/// fn serializer<'w>(&self, writer: Writer<'w>) -> IntoSerializer<'w> {
/// IntoSerializer::erase(rmp_serde::Serializer::new(writer))
/// }
/// }
/// ```
fn serializer<'w>(&self, writer: Writer<'w>) -> IntoSerializer<'w>;
}
/// Handles deserialization of save data.
///
/// Use [`AppLoader`] to override the [`Loader`] that `bevy_save` uses for loading snapshots.
pub trait Loader: Send + Sync + 'static {
/// Build a deserializer trait object from the given reader.
///
/// # Example
/// ```
/// # use bevy_save::prelude::*;
/// pub struct RMPLoader;
///
/// impl Loader for RMPLoader {
/// fn deserializer<'r, 'de>(&self, reader: Reader<'r>) -> IntoDeserializer<'r, 'de> {
/// IntoDeserializer::erase(rmp_serde::Deserializer::new(reader))
/// }
/// }
/// ```
fn deserializer<'r, 'de>(&self, reader: Reader<'r>) -> IntoDeserializer<'r, 'de>;
}
// Saver / Loader Implementations |------------------------------------------------------------------------------------
/// An implementation of [`Saver`] that uses [`rmp_serde::Serializer`].
pub struct RMPSaver;
impl Saver for RMPSaver {
fn serializer<'w>(&self, writer: Writer<'w>) -> IntoSerializer<'w> {
IntoSerializer::erase(rmp_serde::Serializer::new(writer))
}
}
/// An implementation of [`Loader`] that uses [`rmp_serde::Deserializer`].
pub struct RMPLoader;
impl Loader for RMPLoader {
fn deserializer<'r, 'de>(&self, reader: Reader<'r>) -> IntoDeserializer<'r, 'de> {
IntoDeserializer::erase(rmp_serde::Deserializer::new(reader))
}
}
// Resources |---------------------------------------------------------------------------------------------------------
/// The App's [`Saver`].
///
/// `bevy_save` will use this when saving snapshots.
#[derive(Resource)]
pub struct AppSaver(Box<dyn Saver>);
impl AppSaver {
/// Create a new [`AppSaver`] from the given [`Saver`].
pub fn new<S: Saver>(saver: S) -> Self {
Self(Box::new(saver))
}
/// Override the current [`Saver`].
pub fn set<S: Saver>(&mut self, saver: S) {
self.0 = Box::new(saver);
}
/// Returns the current [`Saver`] serializer.
pub fn serializer<'w, W>(&self, writer: W) -> IntoSerializer<'w>
where
W: Into<Writer<'w>>,
{
self.0.serializer(writer.into())
}
/// Serialize the value to the given writer using the current [`Saver`].
///
/// # Errors
/// - See [`Error`]
pub fn serialize<'w, T, W>(&self, value: &T, writer: W) -> Result<(), Error>
where
T: ?Sized + serde::Serialize,
W: Into<Writer<'w>>,
{
value.serialize(&mut self.serializer(writer)).map(|_| ())
}
}
impl Default for AppSaver {
fn default() -> Self {
Self::new(RMPSaver)
}
}
/// The App's [`Loader`].
///
/// `bevy_save` will use this when loading snapshots.
#[derive(Resource)]
pub struct AppLoader(Box<dyn Loader>);
impl AppLoader {
/// Create a new [`AppLoader`] from the given [`Loader`].
pub fn new<L: Loader>(loader: L) -> Self {
Self(Box::new(loader))
}
/// Override the current [`Loader`].
pub fn set<L: Loader>(&mut self, loader: L) {
self.0 = Box::new(loader);
}
/// Returns the current [`Loader`] deserializer.
pub fn deserializer<'r, 'de: 'r, R>(&self, reader: R) -> IntoDeserializer<'r, 'de>
where
R: Into<Reader<'r>>,
{
self.0.deserializer(reader.into())
}
/// Deserialize the type `T` from the given reader using the current [`Loader`].
///
/// # Errors
/// - See [`Error`]
pub fn deserialize<'r, 'de: 'r, T, R>(&self, reader: R) -> Result<T, Error>
where
T: serde::Deserialize<'de>,
R: Into<Reader<'r>>,
{
T::deserialize(&mut self.deserializer(reader))
}
}
impl Default for AppLoader {
fn default() -> Self {
Self::new(RMPLoader)
}
}