Enum StructType

#[non_exhaustive]
pub enum StructType<D>
where
    D: DocReference,
{
    FunctionArg(Handle<Struct<FunctionArgStructField, D>>),
    FunctionReturn(Handle<Struct<FunctionReturnStructField, D>>),
    CallbackArg(Handle<Struct<CallbackArgStructField, D>>),
    Universal(Handle<Struct<UniversalStructField, D>>),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

FunctionArg(Handle<Struct<FunctionArgStructField, D>>)

structs that may be used as native function parameters

FunctionReturn(Handle<Struct<FunctionReturnStructField, D>>)

structs than can be used as native function return values

CallbackArg(Handle<Struct<CallbackArgStructField, D>>)

structs that may be used as callback function arguments in interfaces

Universal(Handle<Struct<UniversalStructField, D>>)

structs that can be used in any context and only contain basic types

Implementations

impl<D> StructType<D>

where D: DocReference,

pub fn initializers(&self) -> &[Handle<Initializer<D>>]

pub fn name(&self) -> &Name

pub fn doc(&self) -> &Doc<D>

pub fn settings(&self) -> &LibrarySettings

pub fn declaration(&self) -> StructDeclarationHandle

pub fn find_field_name(&self, name: &str) -> Option<Name>

pub fn get_default_initializer(&self) -> Option<&Handle<Initializer<D>>>

Trait Implementations

impl<D> Clone for StructType<D>

where D: DocReference + Clone,

fn clone(&self) -> StructType<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D> Debug for StructType<D>

where D: DocReference + Debug,

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

Formats the value using the given formatter.

impl From<Handle<Struct<CallbackArgStructField, Unvalidated>>> for StructType<Unvalidated>

fn from(x: CallbackArgStructHandle) -> Self

Converts to this type from the input type.

impl From<Handle<Struct<FunctionArgStructField, Unvalidated>>> for StructType<Unvalidated>

fn from(x: FunctionArgStructHandle) -> Self

Converts to this type from the input type.

impl From<Handle<Struct<FunctionReturnStructField, Unvalidated>>> for StructType<Unvalidated>

fn from(x: FunctionReturnStructHandle) -> Self

Converts to this type from the input type.

impl From<Handle<Struct<UniversalStructField, Unvalidated>>> for StructType<Unvalidated>

fn from(x: UniversalStructHandle) -> Self

Converts to this type from the input type.

impl<D> Hash for StructType<D>

where D: DocReference + Hash,

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<D> PartialEq for StructType<D>

where D: DocReference + PartialEq,

fn eq(&self, other: &StructType<D>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<D> Eq for StructType<D>

where D: DocReference + Eq,

impl<D> StructuralPartialEq for StructType<D>

where D: DocReference,