bevy_reflect 0.18.1

Dynamically interact with rust types
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
92
93
94
95
96
97
98
99
100
101

use alloc::borrow::Cow;

use crate::{
    func::args::{GetOwnership, Ownership},
    type_info::impl_type_methods,
    Type, TypePath,
};

/// 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>),
}