FromGodot

Trait FromGodot 

Source
pub trait FromGodot: Sized + GodotConvert {
    // Required method
    fn try_from_godot(via: Self::Via) -> Result<Self, ConvertError>;

    // Provided methods
    fn from_godot(via: Self::Via) -> Self { ... }
    fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError> { ... }
    fn from_variant(variant: &Variant) -> Self { ... }
}
Expand description

Defines the canonical conversion from Godot for a type.

It is assumed that all the methods return equal values given equal inputs. Additionally, it is assumed that if ToGodot is implemented, converting to Godot and back again will return a value equal to the starting value.

Violating these assumptions is safe but will give unexpected results.

Please read the godot::meta module docs for further information about conversions.

This trait can be derived using the #[derive(GodotConvert)] macro.

Required Methods§

Source

fn try_from_godot(via: Self::Via) -> Result<Self, ConvertError>

Converts the Godot representation to this type, returning Err on failure.

Provided Methods§

Source

fn from_godot(via: Self::Via) -> Self

⚠️ Converts the Godot representation to this type.

§Panics

If the conversion fails.

Source

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Performs the conversion from a [Variant], returning Err on failure.

Source

fn from_variant(variant: &Variant) -> Self

⚠️ Performs the conversion from a [Variant].

§Panics

If the conversion fails.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

Source§

impl FromGodot for bool

Source§

impl FromGodot for f32

Source§

impl FromGodot for f64

Source§

impl FromGodot for i8

Source§

impl FromGodot for i16

Source§

impl FromGodot for i32

Source§

impl FromGodot for i64

Source§

impl FromGodot for *const c_void

Source§

impl FromGodot for *const u8

Source§

impl FromGodot for *const AudioFrame

Source§

impl FromGodot for *const Glyph

Source§

impl FromGodot for *const ObjectId

Source§

impl FromGodot for *const PhysicsServer2DExtensionMotionResult

Source§

impl FromGodot for *const PhysicsServer2DExtensionRayResult

Source§

impl FromGodot for *const PhysicsServer2DExtensionShapeRestInfo

Source§

impl FromGodot for *const PhysicsServer2DExtensionShapeResult

Source§

impl FromGodot for *const PhysicsServer3DExtensionMotionCollision

Source§

impl FromGodot for *const PhysicsServer3DExtensionMotionResult

Source§

impl FromGodot for *const PhysicsServer3DExtensionRayResult

Source§

impl FromGodot for *const PhysicsServer3DExtensionShapeRestInfo

Source§

impl FromGodot for *const PhysicsServer3DExtensionShapeResult

Source§

impl FromGodot for *const ScriptLanguageExtensionProfilingInfo

Source§

impl FromGodot for *mut c_void

Source§

impl FromGodot for *mut f64

Source§

impl FromGodot for *mut i32

Source§

impl FromGodot for *mut *const u8

Source§

impl FromGodot for *mut u8

Source§

impl FromGodot for *mut AudioFrame

Source§

impl FromGodot for *mut Glyph

Source§

impl FromGodot for *mut ObjectId

Source§

impl FromGodot for *mut PhysicsServer2DExtensionMotionResult

Source§

impl FromGodot for *mut PhysicsServer2DExtensionRayResult

Source§

impl FromGodot for *mut PhysicsServer2DExtensionShapeRestInfo

Source§

impl FromGodot for *mut PhysicsServer2DExtensionShapeResult

Source§

impl FromGodot for *mut PhysicsServer3DExtensionMotionCollision

Source§

impl FromGodot for *mut PhysicsServer3DExtensionMotionResult

Source§

impl FromGodot for *mut PhysicsServer3DExtensionRayResult

Source§

impl FromGodot for *mut PhysicsServer3DExtensionShapeRestInfo

Source§

impl FromGodot for *mut PhysicsServer3DExtensionShapeResult

Source§

impl FromGodot for *mut ScriptLanguageExtensionProfilingInfo

Source§

impl FromGodot for u8

Source§

impl FromGodot for u16

Source§

impl FromGodot for u32

Source§

impl FromGodot for u64

Source§

fn try_from_godot(via: Self::Via) -> Result<Self, ConvertError>

Source§

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Source§

impl FromGodot for ()

Source§

impl FromGodot for String

Source§

impl<T: ArrayElement> FromGodot for Vec<T>

Source§

impl<T: ArrayElement, const LEN: usize> FromGodot for [T; LEN]

Source§

impl<T: FromGodot> FromGodot for Option<T>
where Option<T::Via>: GodotType,

Source§

fn try_from_godot(via: Self::Via) -> Result<Self, ConvertError>

Source§

fn from_godot(via: Self::Via) -> Self

Source§

fn try_from_variant(variant: &Variant) -> Result<Self, ConvertError>

Source§

fn from_variant(variant: &Variant) -> Self

Implementors§

Source§

impl FromGodot for Corner

Source§

impl FromGodot for EulerOrder

Source§

impl FromGodot for Side

Source§

impl FromGodot for ClockDirection

Source§

impl FromGodot for Orientation

Source§

impl FromGodot for VariantOperator

Source§

impl FromGodot for VariantType

Source§

impl FromGodot for ClipChildrenMode

Source§

impl FromGodot for TextureFilter

Source§

impl FromGodot for TextureRepeat

Source§

impl FromGodot for ApiType

Source§

impl FromGodot for AfterGuiInput

Source§

impl FromGodot for CustomControlContainer

Source§

impl FromGodot for DockSlot

Source§

impl FromGodot for CompressionMode

Source§

impl FromGodot for ModeFlags

Source§

impl FromGodot for UnixPermissionFlags

Source§

impl FromGodot for Result

Source§

impl FromGodot for CursorShape

Source§

impl FromGodot for MouseMode

Source§

impl FromGodot for godot_core::classes::mesh::ArrayCustomFormat

Source§

impl FromGodot for godot_core::classes::mesh::ArrayFormat

Source§

impl FromGodot for godot_core::classes::mesh::ArrayType

Source§

impl FromGodot for godot_core::classes::mesh::BlendShapeMode

Source§

impl FromGodot for godot_core::classes::mesh::PrimitiveType

Source§

impl FromGodot for AutoTranslateMode

Source§

impl FromGodot for DuplicateFlags

Source§

impl FromGodot for InternalMode

Source§

impl FromGodot for PhysicsInterpolationMode

Source§

impl FromGodot for ProcessMode

Source§

impl FromGodot for ProcessThreadGroup

Source§

impl FromGodot for ProcessThreadMessages

Source§

impl FromGodot for RotationEditMode

Source§

impl FromGodot for ConnectFlags

Source§

impl FromGodot for RenderingDriver

Source§

impl FromGodot for StdHandleType

Source§

impl FromGodot for SystemDir

Source§

impl FromGodot for GenEditState

Source§

impl FromGodot for godot_core::classes::rendering_server::ArrayCustomFormat

Source§

impl FromGodot for godot_core::classes::rendering_server::ArrayFormat

Source§

impl FromGodot for godot_core::classes::rendering_server::ArrayType

Source§

impl FromGodot for BakeChannels

Source§

impl FromGodot for godot_core::classes::rendering_server::BlendShapeMode

Source§

impl FromGodot for CanvasGroupMode

Source§

impl FromGodot for CanvasItemTextureFilter

Source§

impl FromGodot for CanvasItemTextureRepeat

Source§

impl FromGodot for CanvasLightBlendMode

Source§

impl FromGodot for CanvasLightMode

Source§

impl FromGodot for CanvasLightShadowFilter

Source§

impl FromGodot for CanvasOccluderPolygonCullMode

Source§

impl FromGodot for CanvasTextureChannel

Source§

impl FromGodot for CompositorEffectCallbackType

Source§

impl FromGodot for CompositorEffectFlags

Source§

impl FromGodot for CubeMapLayer

Source§

impl FromGodot for DecalFilter

Source§

impl FromGodot for DecalTexture

Source§

impl FromGodot for DofBlurQuality

Source§

impl FromGodot for DofBokehShape

Source§

impl FromGodot for EnvironmentAmbientSource

Source§

impl FromGodot for EnvironmentBg

Source§

impl FromGodot for EnvironmentFogMode

Source§

impl FromGodot for EnvironmentGlowBlendMode

Source§

impl FromGodot for EnvironmentReflectionSource

Source§

impl FromGodot for EnvironmentSdfgiFramesToConverge

Source§

impl FromGodot for EnvironmentSdfgiFramesToUpdateLight

Source§

impl FromGodot for EnvironmentSdfgiRayCount

Source§

impl FromGodot for EnvironmentSdfgiYScale

Source§

impl FromGodot for EnvironmentSsaoQuality

Source§

impl FromGodot for EnvironmentSsilQuality

Source§

impl FromGodot for EnvironmentSsrRoughnessQuality

Source§

impl FromGodot for EnvironmentToneMapper

Source§

impl FromGodot for Features

Source§

impl FromGodot for FogVolumeShape

Source§

impl FromGodot for GlobalShaderParameterType

Source§

impl FromGodot for InstanceFlags

Source§

impl FromGodot for InstanceType

Source§

impl FromGodot for LightBakeMode

Source§

impl FromGodot for LightDirectionalShadowMode

Source§

impl FromGodot for LightDirectionalSkyMode

Source§

impl FromGodot for LightOmniShadowMode

Source§

impl FromGodot for LightParam

Source§

impl FromGodot for LightProjectorFilter

Source§

impl FromGodot for LightType

Source§

impl FromGodot for MultimeshPhysicsInterpolationQuality

Source§

impl FromGodot for MultimeshTransformFormat

Source§

impl FromGodot for NinePatchAxisMode

Source§

impl FromGodot for ParticlesCollisionHeightfieldResolution

Source§

impl FromGodot for ParticlesCollisionType

Source§

impl FromGodot for ParticlesDrawOrder

Source§

impl FromGodot for ParticlesMode

Source§

impl FromGodot for ParticlesTransformAlign

Source§

impl FromGodot for PipelineSource

Source§

impl FromGodot for godot_core::classes::rendering_server::PrimitiveType

Source§

impl FromGodot for ReflectionProbeAmbientMode

Source§

impl FromGodot for ReflectionProbeUpdateMode

Source§

impl FromGodot for RenderingInfo

Source§

impl FromGodot for ShaderMode

Source§

impl FromGodot for ShadowCastingSetting

Source§

impl FromGodot for ShadowQuality

Source§

impl FromGodot for SkyMode

Source§

impl FromGodot for SubSurfaceScatteringQuality

Source§

impl FromGodot for TextureLayeredType

Source§

impl FromGodot for TextureType

Source§

impl FromGodot for ViewportAnisotropicFiltering

Source§

impl FromGodot for ViewportClearMode

Source§

impl FromGodot for ViewportDebugDraw

Source§

impl FromGodot for ViewportEnvironmentMode

Source§

impl FromGodot for ViewportMsaa

Source§

impl FromGodot for ViewportOcclusionCullingBuildQuality

Source§

impl FromGodot for ViewportRenderInfo

Source§

impl FromGodot for ViewportRenderInfoType

Source§

impl FromGodot for ViewportScaling3DMode

Source§

impl FromGodot for ViewportScreenSpaceAa

Source§

impl FromGodot for ViewportSdfOversize

Source§

impl FromGodot for ViewportSdfScale

Source§

impl FromGodot for ViewportUpdateMode

Source§

impl FromGodot for ViewportVrsMode

Source§

impl FromGodot for ViewportVrsUpdateMode

Source§

impl FromGodot for VisibilityRangeFadeMode

Source§

impl FromGodot for VoxelGiQuality

Source§

impl FromGodot for DeepDuplicateMode

Source§

impl FromGodot for godot_core::classes::resource_format_loader::CacheMode

Source§

impl FromGodot for godot_core::classes::resource_loader::CacheMode

Source§

impl FromGodot for ThreadLoadStatus

Source§

impl FromGodot for SaverFlags

Source§

impl FromGodot for GroupCallFlags

Source§

impl FromGodot for ScriptNameCasing

Source§

impl FromGodot for CodeCompletionKind

Source§

impl FromGodot for CodeCompletionLocation

Source§

impl FromGodot for LookupResultType

Source§

impl FromGodot for Month

Source§

impl FromGodot for Weekday

Source§

impl FromGodot for AnisotropicFiltering

Source§

impl FromGodot for DebugDraw

Source§

impl FromGodot for DefaultCanvasItemTextureFilter

Source§

impl FromGodot for DefaultCanvasItemTextureRepeat

Source§

impl FromGodot for Msaa

Source§

impl FromGodot for PositionalShadowAtlasQuadrantSubdiv

Source§

impl FromGodot for RenderInfo

Source§

impl FromGodot for RenderInfoType

Source§

impl FromGodot for Scaling3DMode

Source§

impl FromGodot for ScreenSpaceAa

Source§

impl FromGodot for SdfOversize

Source§

impl FromGodot for SdfScale

Source§

impl FromGodot for VrsMode

Source§

impl FromGodot for VrsUpdateMode

Source§

impl FromGodot for ContentScaleAspect

Source§

impl FromGodot for ContentScaleMode

Source§

impl FromGodot for ContentScaleStretch

Source§

impl FromGodot for Flags

Source§

impl FromGodot for LayoutDirection

Source§

impl FromGodot for Mode

Source§

impl FromGodot for WindowInitialPosition

Source§

impl FromGodot for Error

Source§

impl FromGodot for HorizontalAlignment

Source§

impl FromGodot for InlineAlignment

Source§

impl FromGodot for JoyAxis

Source§

impl FromGodot for JoyButton

Source§

impl FromGodot for Key

Source§

impl FromGodot for KeyLocation

Source§

impl FromGodot for KeyModifierMask

Source§

impl FromGodot for MethodFlags

Source§

impl FromGodot for MidiMessage

Source§

impl FromGodot for MouseButton

Source§

impl FromGodot for MouseButtonMask

Source§

impl FromGodot for PropertyHint

Source§

impl FromGodot for PropertyUsageFlags

Source§

impl FromGodot for VerticalAlignment

Source§

impl FromGodot for InstanceId

Source§

impl<T, D> FromGodot for DynGd<T, D>
where T: GodotClass, D: ?Sized + 'static,

Source§

impl<T: GodotClass> FromGodot for Gd<T>