bevy_mod_scripting_bindings 0.19.0

Core traits and structures required for smoothly interfacing with other languages in a generic way
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
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

//! Trait implementations to help with function dispatch.

use std::{ffi::OsString, path::PathBuf};

use bevy_platform::collections::HashMap;

use crate::{ReflectReference, ScriptValue, docgen::TypedThrough, error::InteropError};

use super::{
    from::{FromScript, Mut, Ref, Union, Val},
    into::IntoScript,
    script_function::{DynamicScriptFunction, DynamicScriptFunctionMut, FunctionCallContext},
    type_dependencies::GetTypeDependencies,
};

/// Marker trait for types that can be used as arguments to a script function.
pub trait ScriptArgument: ArgMeta + FromScript + GetTypeDependencies {}
impl<T: ArgMeta + FromScript + GetTypeDependencies> ScriptArgument for T {}

/// Marker trait for types that can be used as arguments to a script function. And contain type information.
pub trait TypedScriptArgument: TypedThrough + ScriptArgument {}
impl<T: TypedThrough + ScriptArgument> TypedScriptArgument for T {}

/// Marker trait for types that can be used as return values from a script function.
pub trait ScriptReturn: IntoScript + GetTypeDependencies {}
impl<T: IntoScript + GetTypeDependencies> ScriptReturn for T {}

/// Marker trait for types that can be used as return values from a script function. And contain type information.
pub trait TypedScriptReturn: TypedThrough + ScriptReturn {}
impl<T: TypedThrough + ScriptReturn> TypedScriptReturn for T {}

/// Describes an argument to a script function. Provides necessary information for the function to handle dispatch.
pub trait ArgMeta {
    /// The default value for the argument. Used when the argument is not provided.
    fn default_value() -> Option<ScriptValue> {
        None
    }
}

impl ArgMeta for ScriptValue {}

macro_rules! impl_arg_info {
    ($($ty:ty),*) => {
        $(
            impl ArgMeta for $ty {}
        )*
    };
}

impl_arg_info!(
    bool,
    i8,
    i16,
    i32,
    i64,
    i128,
    u8,
    u16,
    u32,
    u64,
    u128,
    f32,
    f64,
    usize,
    isize,
    String,
    PathBuf,
    OsString,
    char,
    ReflectReference,
    &'static str
);

impl<T1, T2> ArgMeta for Union<T1, T2> {}
impl<T> ArgMeta for Val<T> {}
impl<T> ArgMeta for Ref<'_, T> {}
impl<T> ArgMeta for Mut<'_, T> {}

impl<T> ArgMeta for Result<T, InteropError> {}

impl<T> ArgMeta for Option<T> {
    fn default_value() -> Option<ScriptValue> {
        Some(ScriptValue::Unit)
    }
}

impl<T> ArgMeta for Vec<T> {}
impl<T, const N: usize> ArgMeta for [T; N] {}

impl<K, V> ArgMeta for HashMap<K, V> {}
impl<K, V> ArgMeta for std::collections::HashMap<K, V> {}

impl_arg_info!(DynamicScriptFunction, DynamicScriptFunctionMut);

impl ArgMeta for () {
    fn default_value() -> Option<ScriptValue> {
        Some(ScriptValue::Unit)
    }
}
impl<T> ArgMeta for (T,) {}
impl<T1, T2> ArgMeta for (T1, T2) {}
impl<T1, T2, T3> ArgMeta for (T1, T2, T3) {}
impl<T1, T2, T3, T4> ArgMeta for (T1, T2, T3, T4) {}
impl<T1, T2, T3, T4, T5> ArgMeta for (T1, T2, T3, T4, T5) {}
impl<T1, T2, T3, T4, T5, T6> ArgMeta for (T1, T2, T3, T4, T5, T6) {}
impl<T1, T2, T3, T4, T5, T6, T7> ArgMeta for (T1, T2, T3, T4, T5, T6, T7) {}
impl<T1, T2, T3, T4, T5, T6, T7, T8> ArgMeta for (T1, T2, T3, T4, T5, T6, T7, T8) {}
impl<T1, T2, T3, T4, T5, T6, T7, T8, T9> ArgMeta for (T1, T2, T3, T4, T5, T6, T7, T8, T9) {}
impl<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10> ArgMeta
    for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)
{
}
impl<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> ArgMeta
    for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)
{
}
impl<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12> ArgMeta
    for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)
{
}
impl<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13> ArgMeta
    for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)
{
}

impl ArgMeta for FunctionCallContext {}