Struct rhai::CustomTypeInfo

#[non_exhaustive]
pub struct CustomTypeInfo {
    pub type_name: Identifier,
    pub display_name: Identifier,
    pub comments: StaticVec<SmartString<LazyCompact>>,
}

(internals) Information for a registered custom type. Exported under the internals feature only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type_name: Identifier

Rust name of the custom type.

display_name: Identifier

Friendly display name of the custom type.

comments: StaticVec<SmartString<LazyCompact>>

Comments.

Block doc-comments are kept in separate strings.

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

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

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

Trait Implementations

impl Clone for CustomTypeInfo

fn clone(&self) -> CustomTypeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomTypeInfo

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

Formats the value using the given formatter.

impl Hash for CustomTypeInfo

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CustomTypeInfo

fn eq(&self, other: &CustomTypeInfo) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CustomTypeInfo

impl StructuralPartialEq for CustomTypeInfo