Struct rhai::ScriptFnDef

pub struct ScriptFnDef {
    pub body: StmtBlock,
    pub name: ImmutableString,
    pub access: FnAccess,
    pub this_type: Option<ImmutableString>,
    pub params: SmallVec<[ImmutableString; 5]>,
    pub comments: Box<[SmartString<LazyCompact>]>,
}

Expand description

(internals) A type containing information on a script-defined function. Exported under the internals feature only.

Fields§

§body: StmtBlock

Function body.

§name: ImmutableString

Function name.

§access: FnAccess

Function access mode.

§this_type: Option<ImmutableString>

Type of this pointer, if any. Not available under no_object.

§params: SmallVec<[ImmutableString; 5]>

Names of function parameters.

§comments: Box<[SmartString<LazyCompact>]>

(metadata) Function doc-comments (if any). Exported under the metadata feature only.

Doc-comments are comment lines beginning with /// or comment blocks beginning with /**, placed immediately before a function definition.

Block doc-comments are kept in a single string with line-breaks within.

Line doc-comments are merged, with line-breaks, into a single string without a termination line-break.

Leading white-spaces are stripped, and each string always starts with the corresponding doc-comment leader: /// or /**.

Each line in non-block doc-comments starts with ///.

Trait Implementations§

impl Clone for ScriptFnDef

fn clone(&self) -> ScriptFnDef

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for ScriptFnDef

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

Formats the value using the given formatter. Read more

impl Display for ScriptFnDef

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

Formats the value using the given formatter. Read more

impl<'a> From<&'a ScriptFnDef> for ScriptFnMetadata<'a>

fn from(value: &'a ScriptFnDef) -> Self

Converts to this type from the input type.

impl From<ScriptFnDef> for CallableFunction

fn from(fn_def: ScriptFnDef) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

impl !RefUnwindSafe for ScriptFnDef

impl !Send for ScriptFnDef

impl !Sync for ScriptFnDef

impl Unpin for ScriptFnDef

impl !UnwindSafe for ScriptFnDef

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for Twhere 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> ToOwned for Twhere 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> ToString for Twhere T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.

impl<T> Variant for Twhere T: Any + Clone + SendSync,

fn as_any(&self) -> &(dyn Any + 'static)

Convert this Variant trait object to &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert this Variant trait object to &mut dyn Any.

fn as_boxed_any(self: Box<T>) -> Box<dyn Any>

Convert this Variant trait object to Box<dyn Any>.

fn type_name(&self) -> &'static str

Get the name of this type.

fn clone_object(&self) -> Box<dyn Variant>

Clone this Variant trait object.