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 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
//! An asset interface for Bones.
#![warn(missing_docs)]
// This cfg_attr is needed because `rustdoc::all` includes lints not supported on stable
#![cfg_attr(doc, allow(unknown_lints))]
#![deny(rustdoc::all)]
use serde::{de::DeserializeSeed, Deserializer};
/// Helper to export the same types in the crate root and in the prelude.
macro_rules! pub_use {
() => {
pub use crate::{asset::*, cid::*, handle::*, io::*, network_handle::*, server::*};
pub use anyhow;
pub use bones_schema::prelude::*;
pub use dashmap;
pub use futures_lite::future::Boxed as BoxedFuture;
pub use path_absolutize::Absolutize;
pub use semver::Version;
};
}
pub_use!();
/// The prelude.
pub mod prelude {
pub_use!();
pub use super::{Maybe, Maybe::*};
}
mod asset;
mod cid;
mod handle;
mod io;
mod network_handle;
mod parse;
mod server;
/// An equivalent to [`Option<T>`] that has a stable memory layout and implements [`HasSchema`].
#[derive(HasSchema, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Default, Debug)]
#[type_data(SchemaMetaAssetLoader(maybe_loader))]
#[repr(C, u8)]
pub enum Maybe<T> {
/// The value is not set.
#[default]
Unset,
/// The value is set.
Set(T),
}
impl<T> Maybe<T> {
/// Convert this [`Maybe`] into an [`Option`].
#[inline]
pub fn option(self) -> Option<T> {
self.into()
}
/// Returns `true` if the option is a `Set` value.
#[inline]
pub fn is_set(&self) -> bool {
matches!(self, Maybe::Set(_))
}
/// Returns `true` if the option is an `Unset` value.
#[inline]
pub fn is_unset(&self) -> bool {
matches!(self, Maybe::Unset)
}
/// Returns `true` if the option is a `Set` value.
#[inline]
pub fn is_some(&self) -> bool {
matches!(self, Maybe::Set(_))
}
/// Returns `true` if the option is an `Unset` value.
#[inline]
pub fn is_none(&self) -> bool {
matches!(self, Maybe::Unset)
}
/// Returns `true` if the option is a `Set` value containing the given value.
#[inline]
pub fn contains<U>(&self, x: &U) -> bool
where
U: PartialEq<T>,
{
match self {
Maybe::Set(y) => x == y,
Maybe::Unset => false,
}
}
/// Converts from `&Maybe<T>` to `Maybe<&T>`.
#[inline]
pub fn as_ref(&self) -> Maybe<&T> {
match *self {
Maybe::Unset => Maybe::Unset,
Maybe::Set(ref x) => Maybe::Set(x),
}
}
/// Converts from `&mut Maybe<T>` to `Maybe<&mut T>`.
#[inline]
pub fn as_mut(&mut self) -> Maybe<&mut T> {
match *self {
Maybe::Unset => Maybe::Unset,
Maybe::Set(ref mut x) => Maybe::Set(x),
}
}
/// Returns the contained `Set` value, consuming the `self` value.
#[inline]
#[track_caller]
pub fn expect(self, msg: &str) -> T {
self.option().expect(msg)
}
/// Returns the contained `Set` value, consuming the `self` value.
#[inline]
#[track_caller]
pub fn unwrap(self) -> T {
self.option().unwrap()
}
/// Returns the contained `Set` value or a provided default.
#[inline]
pub fn unwrap_or(self, default: T) -> T {
self.option().unwrap_or(default)
}
/// Returns the contained `Set` value or computes it from a closure.
#[inline]
pub fn unwrap_or_else<F: FnOnce() -> T>(self, f: F) -> T {
self.option().unwrap_or_else(f)
}
/// Maps a `Maybe<T>` to `Maybe<U>` by applying a function to a contained value.
#[inline]
pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Maybe<U> {
self.option().map(f).into()
}
/// Returns `Unset` if the option is `Unset`, otherwise calls `f` with the wrapped value and returns the result.
#[inline]
pub fn and_then<U, F: FnOnce(T) -> Maybe<U>>(self, f: F) -> Maybe<U> {
self.option().and_then(|x| f(x).option()).into()
}
/// Returns `Unset` if the option is `Unset`, otherwise returns `optb`.
#[inline]
pub fn and<U>(self, optb: Maybe<U>) -> Maybe<U> {
self.option().and(optb.option()).into()
}
/// Returns `Unset` if the option is `Unset`, otherwise calls `predicate` with the wrapped value and returns:
#[inline]
pub fn filter<P: FnOnce(&T) -> bool>(self, predicate: P) -> Maybe<T> {
self.option().filter(predicate).into()
}
/// Returns the option if it contains a value, otherwise returns `optb`.
#[inline]
pub fn or(self, optb: Maybe<T>) -> Maybe<T> {
self.option().or(optb.option()).into()
}
/// Returns the option if it contains a value, otherwise calls `f` and returns the result.
#[inline]
pub fn or_else<F: FnOnce() -> Maybe<T>>(self, f: F) -> Maybe<T> {
self.option().or_else(|| f().option()).into()
}
/// Returns `Set` if exactly one of `self`, `optb` is `Set`, otherwise returns `Unset`.
#[inline]
pub fn xor(self, optb: Maybe<T>) -> Maybe<T> {
self.option().xor(optb.option()).into()
}
/// Inserts `v` into the option if it is `Unset`, then returns a mutable reference to the contained value.
#[inline]
pub fn get_or_insert(&mut self, v: T) -> &mut T {
if let Maybe::Unset = self {
*self = Maybe::Set(v);
}
match self {
Maybe::Set(ref mut v) => v,
Maybe::Unset => unreachable!(),
}
}
/// Inserts a value computed from `f` into the option if it is `Unset`, then returns a mutable reference to the contained value.
#[inline]
pub fn get_or_insert_with<F: FnOnce() -> T>(&mut self, f: F) -> &mut T {
if let Maybe::Unset = self {
*self = Maybe::Set(f());
}
match self {
Maybe::Set(ref mut v) => v,
Maybe::Unset => unreachable!(),
}
}
/// Takes the value out of the option, leaving an `Unset` in its place.
#[inline]
pub fn take(&mut self) -> Maybe<T> {
std::mem::replace(self, Maybe::Unset)
}
/// Replaces the actual value in the option by the value given in parameter, returning the old value if present.
#[inline]
pub fn replace(&mut self, value: T) -> Maybe<T> {
std::mem::replace(self, Maybe::Set(value))
}
/// Zips `self` with another `Maybe`.
#[inline]
pub fn zip<U>(self, other: Maybe<U>) -> Maybe<(T, U)> {
self.option().zip(other.option()).into()
}
/// Returns the contained `Set` value, consuming the `self` value, without checking that the value is not `Unset`.
///
/// # Safety
///
/// Calling this method on an `Unset` value is undefined behavior.
#[inline]
pub unsafe fn unwrap_unchecked(self) -> T {
self.option().unwrap_unchecked()
}
/// Maps a `Maybe<T>` to `U` by applying a function to a contained value, or returns a default.
#[inline]
pub fn map_or<U, F: FnOnce(T) -> U>(self, default: U, f: F) -> U {
self.option().map_or(default, f)
}
/// Maps a `Maybe<T>` to `U` by applying a function to a contained value, or computes a default.
#[inline]
pub fn map_or_else<U, D: FnOnce() -> U, F: FnOnce(T) -> U>(self, default: D, f: F) -> U {
self.option().map_or_else(default, f)
}
/// Returns the contained `Set` value or a default.
#[inline]
pub fn unwrap_or_default(self) -> T
where
T: Default,
{
self.option().unwrap_or_default()
}
/// Transforms the `Maybe<T>` into a `Result<T, E>`, mapping `Set(v)` to `Ok(v)` and `Unset` to `Err(err)`.
#[inline]
pub fn ok_or<E>(self, err: E) -> Result<T, E> {
self.option().ok_or(err)
}
/// Transforms the `Maybe<T>` into a `Result<T, E>`, mapping `Set(v)` to `Ok(v)` and `Unset` to `Err(err())`.
#[inline]
pub fn ok_or_else<E, F: FnOnce() -> E>(self, err: F) -> Result<T, E> {
self.option().ok_or_else(err)
}
}
impl<T> From<Maybe<T>> for Option<T> {
#[inline]
fn from(value: Maybe<T>) -> Self {
match value {
Maybe::Set(s) => Some(s),
Maybe::Unset => None,
}
}
}
impl<T> From<Option<T>> for Maybe<T> {
#[inline]
fn from(value: Option<T>) -> Self {
match value {
Some(s) => Maybe::Set(s),
None => Maybe::Unset,
}
}
}
fn maybe_loader(
ctx: &mut MetaAssetLoadCtx,
ptr: SchemaRefMut<'_>,
deserialzer: &mut dyn erased_serde::Deserializer,
) -> anyhow::Result<()> {
deserialzer.deserialize_option(MaybeVisitor { ctx, ptr })?;
Ok(())
}
struct MaybeVisitor<'a, 'srv> {
ctx: &'a mut MetaAssetLoadCtx<'srv>,
ptr: SchemaRefMut<'a>,
}
impl<'a, 'srv, 'de> serde::de::Visitor<'de> for MaybeVisitor<'a, 'srv> {
type Value = ();
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(formatter, "an optional value")
}
fn visit_unit<E>(self) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
Ok(())
}
fn visit_none<E>(self) -> Result<Self::Value, E>
where
E: serde::de::Error,
{
Ok(())
}
fn visit_some<D>(self, deserializer: D) -> Result<Self::Value, D::Error>
where
D: Deserializer<'de>,
{
// Write the enum discriminant for the `Set` variant
// SOUND: we know the discriminant due to the `#[repr(C, u8)]` annotation.
unsafe {
self.ptr.as_ptr().cast::<u8>().write(1);
}
// Get the pointer to the enum value
let value_offset = self.ptr.schema().field_offsets()[0].1;
// NOTE: we take the schema of the first argument of the second enum variant of the
// [`Maybe`] enum because we know that the `Set` variant only has one argument at offset 0
// and we actually want to deserialize the inner type, not a typle of length zero.
let value_schema = self.ptr.schema().kind.as_enum().unwrap().variants[1]
.schema
.kind
.as_struct()
.unwrap()
.fields[0]
.schema;
// SOUND: the schema asserts this is valid.
let value_ref = unsafe {
SchemaRefMut::from_ptr_schema(self.ptr.as_ptr().add(value_offset), value_schema)
};
// Load the enum value
SchemaPtrLoadCtx {
ctx: self.ctx,
ptr: value_ref,
}
.deserialize(deserializer)
}
}