Trait FromScript 

pub trait FromScript {
    type This<'w>;

    // Required method
    fn from_script(
        value: ScriptValue,
        world: WorldGuard<'_>,
    ) -> Result<Self::This<'_>, InteropError>
       where Self: Sized;
}

Describes the procedure for constructing a value of type T from a ScriptValue.

The FromScript::This associated type is used to allow for the implementation of this trait to return a type with the lifetime of the world guard. In 99% cases you can just use Self as the associated type.

Required Associated Types

type This<'w>

The type that is constructed from the script value.

Required Methods

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self::This<'_>, InteropError>

where Self: Sized,

Construct a value of type T from a ScriptValue.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl FromScript for ()

type This<'w> = ()

fn from_script( _value: ScriptValue, _world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for NonMaxU32

type This<'w> = NonMaxU32

fn from_script( value: ScriptValue, _world: WorldGuard<'_>, ) -> Result<Self::This<'_>, InteropError>

where Self: Sized,

impl FromScript for OsString

type This<'w> = OsString

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for PathBuf

type This<'w> = PathBuf

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for String

type This<'w> = String

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for bool

type This<'w> = bool

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self::This<'_>, InteropError>

where Self: Sized,

impl FromScript for char

type This<'w> = char

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self::This<'_>, InteropError>

where Self: Sized,

impl FromScript for f32

type This<'w> = f32

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for f64

type This<'w> = f64

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for i8

type This<'w> = i8

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for i16

type This<'w> = i16

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for i32

type This<'w> = i32

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for i64

type This<'w> = i64

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for i128

type This<'w> = i128

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for isize

type This<'w> = isize

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for u8

type This<'w> = u8

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for u16

type This<'w> = u16

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for u32

type This<'w> = u32

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for u64

type This<'w> = u64

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for u128

type This<'w> = u128

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl FromScript for usize

type This<'w> = usize

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript, T9: FromScript, T10: FromScript, T11: FromScript, T12: FromScript, T13: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>, for<'w> T9::This<'w>: Into<T9>, for<'w> T10::This<'w>: Into<T10>, for<'w> T11::This<'w>: Into<T11>, for<'w> T12::This<'w>: Into<T12>, for<'w> T13::This<'w>: Into<T13>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript, T9: FromScript, T10: FromScript, T11: FromScript, T12: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>, for<'w> T9::This<'w>: Into<T9>, for<'w> T10::This<'w>: Into<T10>, for<'w> T11::This<'w>: Into<T11>, for<'w> T12::This<'w>: Into<T12>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript, T9: FromScript, T10: FromScript, T11: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>, for<'w> T9::This<'w>: Into<T9>, for<'w> T10::This<'w>: Into<T10>, for<'w> T11::This<'w>: Into<T11>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript, T9: FromScript, T10: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>, for<'w> T9::This<'w>: Into<T9>, for<'w> T10::This<'w>: Into<T10>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript, T9: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>, for<'w> T9::This<'w>: Into<T9>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript, T8: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>, for<'w> T8::This<'w>: Into<T8>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7, T8)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript, T7: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6, T7)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>, for<'w> T7::This<'w>: Into<T7>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6, T7)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript, T6: FromScript> FromScript for (T0, T1, T2, T3, T4, T5, T6)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>, for<'w> T6::This<'w>: Into<T6>,

type This<'w> = (T0, T1, T2, T3, T4, T5, T6)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript, T5: FromScript> FromScript for (T0, T1, T2, T3, T4, T5)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>, for<'w> T5::This<'w>: Into<T5>,

type This<'w> = (T0, T1, T2, T3, T4, T5)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript, T4: FromScript> FromScript for (T0, T1, T2, T3, T4)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>, for<'w> T4::This<'w>: Into<T4>,

type This<'w> = (T0, T1, T2, T3, T4)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript, T3: FromScript> FromScript for (T0, T1, T2, T3)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>, for<'w> T3::This<'w>: Into<T3>,

type This<'w> = (T0, T1, T2, T3)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript, T2: FromScript> FromScript for (T0, T1, T2)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>, for<'w> T2::This<'w>: Into<T2>,

type This<'w> = (T0, T1, T2)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript, T1: FromScript> FromScript for (T0, T1)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>, for<'w> T1::This<'w>: Into<T1>,

type This<'w> = (T0, T1)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T0: FromScript> FromScript for (T0,)

where Self: 'static, for<'w> T0::This<'w>: Into<T0>,

type This<'w> = (T0,)

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T: FromScript + 'static, const N: usize> FromScript for [T; N]

where for<'w> T::This<'w>: Into<T>,

type This<'w> = [T; N]

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T: FromScript + 'static> FromScript for Vec<T>

where for<'w> T::This<'w>: Into<T>,

type This<'w> = Vec<T>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T: FromScript + 'static> FromScript for VecDeque<T>

where for<'w> T::This<'w>: Into<T>,

type This<'w> = VecDeque<T>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<T: FromScript> FromScript for Option<T>

where for<'w> T::This<'w>: Into<T>,

type This<'w> = Option<T>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<V> FromScript for HashMap<String, V>

where V: FromScript + 'static, for<'w> V::This<'w>: Into<V>,

type This<'w> = HashMap<String, V>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<V> FromScript for HashMap<String, V>

where V: FromScript + 'static, for<'w> V::This<'w>: Into<V>,

type This<'w> = HashMap<String, V>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

impl<V> FromScript for HashSet<V>

where V: FromScript + Eq + Hash + 'static, for<'w> V::This<'w>: Into<V>,

type This<'w> = HashSet<V>

fn from_script( value: ScriptValue, world: WorldGuard<'_>, ) -> Result<Self, InteropError>

Implementors

impl FromScript for DynamicScriptFunction

type This<'w> = DynamicScriptFunction

impl FromScript for DynamicScriptFunctionMut

type This<'w> = DynamicScriptFunctionMut

impl FromScript for ReflectReference

type This<'w> = ReflectReference

impl FromScript for ScriptValue

type This<'w> = ScriptValue

impl FromScript for VariadicTuple

type This<'w> = VariadicTuple

impl<T1: FromScript, T2: FromScript> FromScript for Union<T1, T2>

where for<'a> T1::This<'a>: Into<T1>, for<'a> T2::This<'a>: Into<T2>,

type This<'w> = Union<T1, T2>

impl<T: FromReflect> FromScript for M<'_, T>

type This<'w> = M<'w, T>

impl<T: FromReflect> FromScript for R<'_, T>

type This<'a> = R<'a, T>

impl<T: FromReflect> FromScript for V<T>

type This<'w> = V<T>