bf765e61b5
# Objective - Contributes to #15460 ## Solution - Added `std` feature (enabled by default) ## Testing - CI - `cargo check -p bevy_reflect --no-default-features --target "x86_64-unknown-none"` - UEFI demo application runs with this branch of `bevy_reflect`, allowing `derive(Reflect)` ## Notes - The [`spin`](https://crates.io/crates/spin) crate has been included to provide `RwLock` and `Once` (as an alternative to `OnceLock`) when the `std` feature is not enabled. Another alternative may be more desirable, please provide feedback if you have a strong opinion here! - Certain items (`Box`, `String`, `ToString`) provided by `alloc` have been added to `__macro_exports` as a way to avoid `alloc` vs `std` namespacing. I'm personally quite annoyed that we can't rely on `alloc` as a crate name in `std` environments within macros. I'd love an alternative to my approach here, but I suspect it's the least-bad option. - I would've liked to have an `alloc` feature (for allocation-free `bevy_reflect`), unfortunately, `erased_serde` unconditionally requires access to `Box`. Maybe one day we could design around this, but for now it just means `bevy_reflect` requires `alloc`. --------- Co-authored-by: Gino Valente <49806985+MrGVSV@users.noreply.github.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
105 lines
3.1 KiB
Rust
105 lines
3.1 KiB
Rust
use alloc::borrow::Cow;
|
|
|
|
use crate::{
|
|
func::args::{GetOwnership, Ownership},
|
|
type_info::impl_type_methods,
|
|
Type, TypePath,
|
|
};
|
|
|
|
#[cfg(not(feature = "std"))]
|
|
use alloc::{boxed::Box, format, vec};
|
|
|
|
/// Type information for an [`Arg`] used in a [`DynamicFunction`] or [`DynamicFunctionMut`].
|
|
///
|
|
/// [`Arg`]: crate::func::args::Arg
|
|
/// [`DynamicFunction`]: crate::func::DynamicFunction
|
|
/// [`DynamicFunctionMut`]: crate::func::DynamicFunctionMut
|
|
#[derive(Debug, Clone)]
|
|
pub struct ArgInfo {
|
|
/// The index of the argument within its function.
|
|
index: usize,
|
|
/// The name of the argument (if provided).
|
|
name: Option<Cow<'static, str>>,
|
|
/// The ownership of the argument.
|
|
ownership: Ownership,
|
|
/// The [type] of the argument.
|
|
///
|
|
/// [type]: Type
|
|
ty: Type,
|
|
}
|
|
|
|
impl ArgInfo {
|
|
/// Create a new [`ArgInfo`] with the given argument index and type `T`.
|
|
///
|
|
/// To set the name of the argument, use [`Self::with_name`].
|
|
pub fn new<T: TypePath + GetOwnership>(index: usize) -> Self {
|
|
Self {
|
|
index,
|
|
name: None,
|
|
ownership: T::ownership(),
|
|
ty: Type::of::<T>(),
|
|
}
|
|
}
|
|
|
|
/// Set the name of the argument.
|
|
///
|
|
/// Reflected arguments are not required to have a name and by default are not given one,
|
|
/// so this method must be called manually to set the name.
|
|
pub fn with_name(mut self, name: impl Into<Cow<'static, str>>) -> Self {
|
|
self.name = Some(name.into());
|
|
self
|
|
}
|
|
|
|
/// The index of the argument within its function.
|
|
pub fn index(&self) -> usize {
|
|
self.index
|
|
}
|
|
|
|
/// The name of the argument, if it was given one.
|
|
///
|
|
/// Note that this may return `None` even if the argument has a name.
|
|
/// This is because the name needs to be manually set using [`Self::with_name`]
|
|
/// since the name can't be inferred from the function type alone.
|
|
///
|
|
/// For [`DynamicFunctions`] created using [`IntoFunction`]
|
|
/// and [`DynamicFunctionMuts`] created using [`IntoFunctionMut`],
|
|
/// the name will always be `None`.
|
|
///
|
|
/// [`DynamicFunctions`]: crate::func::DynamicFunction
|
|
/// [`IntoFunction`]: crate::func::IntoFunction
|
|
/// [`DynamicFunctionMuts`]: crate::func::DynamicFunctionMut
|
|
/// [`IntoFunctionMut`]: crate::func::IntoFunctionMut
|
|
pub fn name(&self) -> Option<&str> {
|
|
self.name.as_deref()
|
|
}
|
|
|
|
/// The ownership of the argument.
|
|
pub fn ownership(&self) -> Ownership {
|
|
self.ownership
|
|
}
|
|
|
|
impl_type_methods!(ty);
|
|
|
|
/// Get an ID representing the argument.
|
|
///
|
|
/// This will return `ArgId::Name` if the argument has a name,
|
|
/// otherwise `ArgId::Index`.
|
|
pub fn id(&self) -> ArgId {
|
|
self.name
|
|
.clone()
|
|
.map(ArgId::Name)
|
|
.unwrap_or_else(|| ArgId::Index(self.index))
|
|
}
|
|
}
|
|
|
|
/// A representation of an argument.
|
|
///
|
|
/// This is primarily used for error reporting and debugging.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub enum ArgId {
|
|
/// The index of the argument within its function.
|
|
Index(usize),
|
|
/// The name of the argument.
|
|
Name(Cow<'static, str>),
|
|
}
|