essences::prelude

Struct TypeBuilder

pub struct TypeBuilder<'a, T>
where
    T: Variant + Clone,
{ /* private fields */ }
Expand description

Builder to build the API of a custom type for use with an [Engine].

The type is automatically registered when this builder is dropped.

§Pretty-Print Name

By default the type is registered with [Engine::register_type] (i.e. without a pretty-print name).

To define a pretty-print name, call with_name, to use [Engine::register_type_with_name] instead.

Implementations§

§

impl<T> TypeBuilder<'_, T>
where T: Variant + Clone,

pub fn with_name(&mut self, name: &str) -> &mut TypeBuilder<'_, T>

Set a pretty-print name for the type_of function.

pub fn on_print( &mut self, on_print: impl Fn(&mut T) -> String + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>

Pretty-print this custom type.

pub fn on_debug( &mut self, on_debug: impl Fn(&mut T) -> String + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>

Debug-print this custom type.

pub fn with_fn<A, const N: usize, const X: bool, R, const F: bool>( &mut self, name: impl AsRef<str> + Into<SmartString<LazyCompact>>, method: impl RhaiNativeFunc<A, N, X, R, F> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where A: 'static, R: Variant + Clone,

Register a custom method.

§

impl<T> TypeBuilder<'_, T>
where T: Variant + Clone + IntoIterator, <T as IntoIterator>::Item: Variant + Clone,

pub fn is_iterable(&mut self) -> &mut TypeBuilder<'_, T>

Register a type iterator. This is an advanced API.

§

impl<T> TypeBuilder<'_, T>
where T: Variant + Clone,

pub fn with_get<const X: bool, R, const F: bool>( &mut self, name: impl AsRef<str>, get_fn: impl RhaiNativeFunc<(Mut<T>,), 1, X, R, F> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where R: Variant + Clone,

Register a getter function.

The function signature must start with &mut self and not &self.

Not available under no_object.

pub fn with_set<const X: bool, R, const F: bool>( &mut self, name: impl AsRef<str>, set_fn: impl RhaiNativeFunc<(Mut<T>, R), 2, X, (), F> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where R: Variant + Clone,

Register a setter function.

Not available under no_object.

pub fn with_get_set<const X1: bool, const X2: bool, R, const F1: bool, const F2: bool>( &mut self, name: impl AsRef<str>, get_fn: impl RhaiNativeFunc<(Mut<T>,), 1, X1, R, F1> + SendSync + 'static, set_fn: impl RhaiNativeFunc<(Mut<T>, R), 2, X2, (), F2> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where R: Variant + Clone,

Short-hand for registering both getter and setter functions.

All function signatures must start with &mut self and not &self.

Not available under no_object.

§

impl<T> TypeBuilder<'_, T>
where T: Variant + Clone,

pub fn with_indexer_get<IDX, const X: bool, R, const F: bool>( &mut self, get_fn: impl RhaiNativeFunc<(Mut<T>, IDX), 2, X, R, F> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where IDX: Variant + Clone, R: Variant + Clone,

Register an index getter.

The function signature must start with &mut self and not &self.

Not available under both no_index and no_object.

pub fn with_indexer_set<IDX, const X: bool, R, const F: bool>( &mut self, set_fn: impl RhaiNativeFunc<(Mut<T>, IDX, R), 3, X, (), F> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where IDX: Variant + Clone, R: Variant + Clone,

Register an index setter.

Not available under both no_index and no_object.

pub fn with_indexer_get_set<IDX, const X1: bool, const X2: bool, R, const F1: bool, const F2: bool>( &mut self, get_fn: impl RhaiNativeFunc<(Mut<T>, IDX), 2, X1, R, F1> + SendSync + 'static, set_fn: impl RhaiNativeFunc<(Mut<T>, IDX, R), 3, X2, (), F2> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where IDX: Variant + Clone, R: Variant + Clone,

Short-hand for registering both index getter and setter functions.

Not available under both no_index and no_object.

§

impl<T> TypeBuilder<'_, T>
where T: Variant + Clone,

pub fn with_result_fn<S, A, const N: usize, const X: bool, R, FUNC>( &mut self, name: S, method: FUNC, ) -> &mut TypeBuilder<'_, T>
where A: 'static, S: AsRef<str> + Into<SmartString<LazyCompact>>, R: Variant + Clone, FUNC: RhaiNativeFunc<A, N, X, R, true> + SendSync + 'static,

👎Deprecated since 1.9.1: use with_fn instead

Register a custom fallible function.

§Deprecated

This method is deprecated. Use with_fn instead.

This method will be removed in the next major version.

pub fn with_get_result<const X: bool, R>( &mut self, name: impl AsRef<str>, get_fn: impl RhaiNativeFunc<(Mut<T>,), 1, X, R, true> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where R: Variant + Clone,

👎Deprecated since 1.9.1: use with_get instead

Register a fallible getter function.

The function signature must start with &mut self and not &self.

Not available under no_object.

§Deprecated

This method is deprecated. Use with_get instead.

This method will be removed in the next major version.

pub fn with_set_result<const X: bool, R>( &mut self, name: impl AsRef<str>, set_fn: impl RhaiNativeFunc<(Mut<T>, R), 2, X, (), true> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where R: Variant + Clone,

👎Deprecated since 1.9.1: use with_set instead

Register a fallible setter function.

Not available under no_object.

§Deprecated

This method is deprecated. Use with_set instead.

This method will be removed in the next major version.

pub fn with_indexer_get_result<IDX, R, const X: bool>( &mut self, get_fn: impl RhaiNativeFunc<(Mut<T>, IDX), 2, X, R, true> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where IDX: Variant + Clone, R: Variant + Clone,

👎Deprecated since 1.9.1: use with_indexer_get instead

Register an fallible index getter.

The function signature must start with &mut self and not &self.

Not available under both no_index and no_object.

§Deprecated

This method is deprecated. Use with_indexer_get instead.

This method will be removed in the next major version.

pub fn with_indexer_set_result<IDX, R, const X: bool>( &mut self, set_fn: impl RhaiNativeFunc<(Mut<T>, IDX, R), 3, X, (), true> + SendSync + 'static, ) -> &mut TypeBuilder<'_, T>
where IDX: Variant + Clone, R: Variant + Clone,

👎Deprecated since 1.9.1: use with_indexer_set instead

Register an fallible index setter.

Not available under both no_index and no_object.

§Deprecated

This method is deprecated. Use with_indexer_set instead.

This method will be removed in the next major version.

Auto Trait Implementations§

§

impl<'a, T> Freeze for TypeBuilder<'a, T>

§

impl<'a, T> !RefUnwindSafe for TypeBuilder<'a, T>

§

impl<'a, T> Send for TypeBuilder<'a, T>

§

impl<'a, T> Sync for TypeBuilder<'a, T>

§

impl<'a, T> Unpin for TypeBuilder<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for TypeBuilder<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more