Enum macro_tools::exposed::struct_like::StructLike

pub enum StructLike {
    Unit(ItemStruct),
    Struct(ItemStruct),
    Enum(ItemEnum),
}

Represents various struct-like constructs in Rust code.

This enum enables differentiation among unit types, structs, and enums, allowing for syntactic analysis and manipulation within macros. StructLike is designed to be used in macro contexts where behaviors may vary based on the struct-like type being processed.

Variants:

• Unit: Represents unit structs, which are types without any fields or data. Useful in scenarios where a type needs to exist but does not hold any data itself, typically used for type-safe markers.
• Struct: Represents regular Rust structs that contain fields. This variant is used to handle data structures that hold multiple related data pieces together in a named format.
• Enum: Represents enums in Rust, which are types that can hold one of multiple possible variants. This is particularly useful for type-safe state or option handling without the use of external discriminators.

Variants

Unit(ItemStruct)

A unit struct with no fields.

Struct(ItemStruct)

A typical Rust struct with named fields.

Enum(ItemEnum)

A Rust enum, which can be one of several defined variants.

Implementations

impl StructLike

pub fn elements<'a>(&'a self) -> impl IterTrait<'a, FieldOrVariant<'a>> + 'a

Returns an iterator over elements of the item.

pub fn attrs(&self) -> &Vec<Attribute>

Returns an iterator over elements of the item.

pub fn vis(&self) -> &Visibility

Returns an iterator over elements of the item.

pub fn ident(&self) -> &Ident

Returns an iterator over elements of the item.

pub fn generics(&self) -> &Generics

Returns an iterator over elements of the item.

pub fn fields<'a>(&'a self) -> impl IterTrait<'a, &'a Field>

Returns an iterator over fields of the item.

pub fn field_names<'a>(&'a self) -> Option<impl IterTrait<'a, &'a Ident> + '_>

Extracts the name of each field.

pub fn field_types<'a>(&'a self) -> impl IterTrait<'a, &'a Type>

Extracts the type of each field.

pub fn field_attrs<'a>(&'a self) -> impl IterTrait<'a, &'a Vec<Attribute>>

Extracts the name of each field.

pub fn first_field(&self) -> Option<&Field>

Extract the first field.

Trait Implementations

impl Debug for StructLike

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

Formats the value using the given formatter.

impl From<ItemEnum> for StructLike

fn from(item_enum: ItemEnum) -> Self

Converts to this type from the input type.

impl From<ItemStruct> for StructLike

fn from(item_struct: ItemStruct) -> Self

Converts to this type from the input type.

impl Parse for StructLike

fn parse(input: ParseStream<'_>) -> Result<Self>

impl PartialEq for StructLike

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

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl StructuralPartialEq for StructLike