Struct NamedDataType

pub struct NamedDataType {
    pub name: &'static str,
    pub sid: Option<TypeSid>,
    pub impl_location: Option<ImplLocation>,
    pub comments: &'static [&'static str],
    pub export: Option<bool>,
    pub deprecated: Option<&'static str>,
    pub item: NamedDataTypeItem,
}

A named type represents a non-primitive type capable of being exported as it’s own named entity.

Fields

name: &'static str

The name of the type

sid: Option<TypeSid>

The Specta ID for the type. The value for this should come from the sid!(); macro.

impl_location: Option<ImplLocation>

The code location where this type is implemented. Used for error reporting.

comments: &'static [&'static str]

Rust documentation comments on the type

export: Option<bool>

DEPRECATED. This is not used and shouldn’t be. Will be removed in Specta v2!

deprecated: Option<&'static str>

The Rust deprecated comment if the type is deprecated.

item: NamedDataTypeItem

the actual type definition.

Trait Implementations

impl Clone for NamedDataType

fn clone(&self) -> NamedDataType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NamedDataType

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

Formats the value using the given formatter.

impl From<NamedDataType> for DataType

fn from(t: NamedDataType) -> Self

Converts to this type from the input type.

impl PartialEq for NamedDataType

fn eq(&self, other: &NamedDataType) -> 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 StructuralPartialEq for NamedDataType