Skip to main content

ClassData

gdscript_api::model

Struct ClassData

pub struct ClassData {
    pub name: String,
    pub base: Option<ClassId>,
    pub is_refcounted: bool,
    pub is_instantiable: bool,
    pub api_type: ApiType,
    pub methods: Vec<MethodSig>,
    pub properties: Vec<PropertyInfo>,
    pub signals: Vec<SignalSig>,
    pub enums: Vec<EnumInfo>,
    pub constants: Vec<ConstInfo>,
    pub doc: Option<DocId>,
}

Expand description

An engine class and its members.

Fields§

§name: String

The class name.

§base: Option<ClassId>

The resolved base class, if any (only Object has none).

§is_refcounted: bool

Whether instances are reference-counted (RefCounted subtree).

§is_instantiable: bool

Whether the class can be instantiated directly.

§api_type: ApiType

Runtime vs. editor-only.

§methods: Vec<MethodSig>

Declared methods (not including inherited).

§properties: Vec<PropertyInfo>

Declared properties.

§signals: Vec<SignalSig>

Declared signals.

§enums: Vec<EnumInfo>

Nested enums.

§constants: Vec<ConstInfo>

Integer constants.

§doc: Option<DocId>

Documentation handle, when the doc store is populated.

Trait Implementations§

impl Archive for ClassData
where String: Archive, Option<ClassId>: Archive, bool: Archive, ApiType: Archive, Vec<MethodSig>: Archive, Vec<PropertyInfo>: Archive, Vec<SignalSig>: Archive, Vec<EnumInfo>: Archive, Vec<ConstInfo>: Archive, Option<DocId>: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize. Read more

type Archived = ArchivedClassData

The archived representation of this type. Read more

type Resolver = ClassDataResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output. Read more

impl Clone for ClassData

fn clone(&self) -> ClassData

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for ClassData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl<D: Fallible + ?Sized> Deserialize<ClassData, D> for Archived<ClassData>
where String: Archive, <String as Archive>::Archived: Deserialize<String, D>, Option<ClassId>: Archive, <Option<ClassId> as Archive>::Archived: Deserialize<Option<ClassId>, D>, bool: Archive, <bool as Archive>::Archived: Deserialize<bool, D>, ApiType: Archive, <ApiType as Archive>::Archived: Deserialize<ApiType, D>, Vec<MethodSig>: Archive, <Vec<MethodSig> as Archive>::Archived: Deserialize<Vec<MethodSig>, D>, Vec<PropertyInfo>: Archive, <Vec<PropertyInfo> as Archive>::Archived: Deserialize<Vec<PropertyInfo>, D>, Vec<SignalSig>: Archive, <Vec<SignalSig> as Archive>::Archived: Deserialize<Vec<SignalSig>, D>, Vec<EnumInfo>: Archive, <Vec<EnumInfo> as Archive>::Archived: Deserialize<Vec<EnumInfo>, D>, Vec<ConstInfo>: Archive, <Vec<ConstInfo> as Archive>::Archived: Deserialize<Vec<ConstInfo>, D>, Option<DocId>: Archive, <Option<DocId> as Archive>::Archived: Deserialize<Option<DocId>, D>,

fn deserialize( &self, deserializer: &mut D, ) -> Result<ClassData, <D as Fallible>::Error>

Deserializes using the given deserializer

impl<S: Fallible + ?Sized> Serialize<S> for ClassData
where String: Serialize<S>, Option<ClassId>: Serialize<S>, bool: Serialize<S>, ApiType: Serialize<S>, Vec<MethodSig>: Serialize<S>, Vec<PropertyInfo>: Serialize<S>, Vec<SignalSig>: Serialize<S>, Vec<EnumInfo>: Serialize<S>, Vec<ConstInfo>: Serialize<S>, Option<DocId>: Serialize<S>,

fn serialize( &self, serializer: &mut S, ) -> Result<<Self as Archive>::Resolver, <S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.

Auto Trait Implementations§

impl Freeze for ClassData

impl RefUnwindSafe for ClassData

impl Send for ClassData

impl Sync for ClassData

impl Unpin for ClassData

impl UnsafeUnpin for ClassData

impl UnwindSafe for ClassData

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<T> ArchiveUnsized for T
where T: Archive,

type Archived = <T as Archive>::Archived

The archived counterpart of this type. Unlike Archive, it may be unsized. Read more

fn archived_metadata( &self, ) -> <<T as ArchiveUnsized>::Archived as ArchivePointee>::ArchivedMetadata

Creates the archived version of the metadata for this value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> LayoutRaw for T

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.

impl<T> Pointee for T

type Metadata = ()

The metadata type for pointers and references to this type.

impl<T, S> SerializeUnsized<S> for T
where T: Serialize<S>, S: Fallible + Writer + ?Sized,

fn serialize_unsized( &self, serializer: &mut S, ) -> Result<usize, <S as Fallible>::Error>

Writes the object and returns the position of the archived type.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.