Struct gdnative_core::export::PropertyBuilder

pub struct PropertyBuilder<'a, C, T: Export, S = InvalidSetter<'a>, G = InvalidGetter<'a>> { /* private fields */ }

Builder type used to register a property on a NativeClass.

Implementations

impl<'a, C, T, S, G> PropertyBuilder<'a, C, T, S, G>where
    C: NativeClass,
    T: Export,
    S: RawSetter<C, T>,
    G: RawGetter<C, T>,

pub fn done(self)

Register the property built with this builder.

pub fn with_setter<NS>(
    self,
    setter: NS
) -> PropertyBuilder<'a, C, T, Setter<Mut, NS>, G>where
    Setter<Mut, NS>: RawSetter<C, T>,

Provides a setter function with the signature fn(&mut C, owner: C::Base, value: T) where C is the NativeClass type being registered and T is the type of the property.

pub fn with_shr_setter<NS>(
    self,
    setter: NS
) -> PropertyBuilder<'a, C, T, Setter<Shr, NS>, G>where
    Setter<Shr, NS>: RawSetter<C, T>,

Provides a setter function with the signature fn(&C, owner: C::Base, value: T) where C is the NativeClass type being registered and T is the type of the property.

“shr” stands for “shared reference”, as opposed to the more common &mut self.

pub fn with_getter<NG>(
    self,
    getter: NG
) -> PropertyBuilder<'a, C, T, S, Getter<Shr, Owned, NG>>where
    Getter<Shr, Owned, NG>: RawGetter<C, T>,

Provides a getter function with the signature fn(&C, owner: C::Base) -> T, where C is the NativeClass type being registered and T is the type of the property.

pub fn with_ref_getter<NG>(
    self,
    getter: NG
) -> PropertyBuilder<'a, C, T, S, Getter<Shr, Ref, NG>>where
    Getter<Shr, Ref, NG>: RawGetter<C, T>,

Provides a getter function with the signature fn(&C, owner: C::Base) -> &T, where C is the NativeClass type being registered and T is the type of the property.

pub fn with_mut_getter<NG>(
    self,
    getter: NG
) -> PropertyBuilder<'a, C, T, S, Getter<Mut, Owned, NG>>where
    Getter<Mut, Owned, NG>: RawGetter<C, T>,

Provides a getter function with the signature fn(&mut C, owner: C::Base) -> T, where C is the NativeClass type being registered and T is the type of the property.

pub fn with_mut_ref_getter<NG>(
    self,
    getter: NG
) -> PropertyBuilder<'a, C, T, S, Getter<Mut, Ref, NG>>where
    Getter<Mut, Ref, NG>: RawGetter<C, T>,

Provides a getter function with the signature fn(&mut C, owner: C::Base) -> &T, where C is the NativeClass type being registered and T is the type of the property.

pub fn with_default(self, default: T) -> Self

Sets a default value for the property as a hint to the editor. The setter may or may not be actually called with this value.

pub fn with_hint(self, hint: T::Hint) -> Self

Sets an editor hint.

pub fn with_usage(self, usage: PropertyUsage) -> Self

Sets a property usage.

pub fn with_rpc_mode(self, rpc_mode: RpcMode) -> Self

Sets a RPC mode.

Trait Implementations

impl<'a, C: Debug, T: Debug + Export, S: Debug, G: Debug> Debug for PropertyBuilder<'a, C, T, S, G>where
    T::Hint: Debug,

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

Formats the value using the given formatter.