Enum ItemKind 

pub enum ItemKind {
    Fn {
        name: GlobalId,
        generics: Generics,
        body: Expr,
        params: Vec<Param>,
        safety: SafetyKind,
    },
    TyAlias {
        name: GlobalId,
        generics: Generics,
        ty: Ty,
    },
    Type {
        name: GlobalId,
        generics: Generics,
        variants: Vec<Variant>,
        is_struct: bool,
    },
    Trait {
        name: GlobalId,
        generics: Generics,
        items: Vec<TraitItem>,
        safety: SafetyKind,
    },
    Impl {
        generics: Generics,
        self_ty: Ty,
        of_trait: (GlobalId, Vec<GenericValue>),
        items: Vec<ImplItem>,
        parent_bounds: Vec<(ImplExpr, ImplIdent)>,
    },
    Alias {
        name: GlobalId,
        item: GlobalId,
    },
    Use {
        path: Vec<String>,
        is_external: bool,
        rename: Option<String>,
    },
    Quote {
        quote: Quote,
        origin: ItemQuoteOrigin,
    },
    RustModule,
    Error(ErrorNode),
    Resugared(ResugaredItemKind),
    NotImplementedYet,
}

A top-level item in the module.

Variants

Fn

A function or constant item.

Example:

fn add<T: Clone>(x: i32, y: i32) -> i32 {
    x + y
}

Constants are represented as functions of arity zero, while functions always have a non-zero arity.

Fields

name: GlobalId

The identifier of the function.

Example:

add

generics: Generics

The generic arguments and constraints of the function.

Example:

the generic type T and the constraint T: Clone

body: Expr

The body of the function

Example:

x + y

params: Vec<Param>

The parameters of the function.

Example:

x: i32, y: i32

safety: SafetyKind

The safety of the function.

TyAlias

A type alias.

Example:

type A = u8;

Fields

name: GlobalId

Name of the alias

Example:

A

generics: Generics

Generic arguments and constraints

ty: Ty

Original type

Example:

u8

Type

A type definition (struct or enum)

Example:

enum A {B, C}
struct S {f: u8}

Fields

name: GlobalId

Name of this type

Example:

A, S

generics: Generics

Generic parameters and constraints

variants: Vec<Variant>

Variants

Example:

{B, C}

is_struct: bool

Is this a struct (or an enum)

Trait

A trait definition.

Example:

trait T<A> {
    type Assoc;
    fn m(x: Self::Assoc, y: Self) -> A;
}

Fields

name: GlobalId

Name of this trait

Example:

T

generics: Generics

Generic parameters and constraints

Example:

<A>

items: Vec<TraitItem>

Items required to implement the trait

Example:

type Assoc;, fn m ...;

safety: SafetyKind

Safe or unsafe

Impl

A trait implementation.

Example:

impl T<u8> for u16 {
    type Assoc = u32;
    fn m(x: u32, y: u16) -> u8 {
        (x as u8) + (y as u8)
    }
}

Fields

generics: Generics

Generic arguments and constraints

self_ty: Ty

The type we implement the trait for

Example:

u16

of_trait: (GlobalId, Vec<GenericValue>)

Instantiated trait that is being implemented

Example:

T<u8>

items: Vec<ImplItem>

Items in this impl

Example:

fn m ..., type Assoc ...

parent_bounds: Vec<(ImplExpr, ImplIdent)>

Implementations of traits required for this impl

Alias

Internal node introduced by phases, corresponds to an alias to any item.

Fields

name: GlobalId

New name

item: GlobalId

Original name

Use

A use statement

Fields

path: Vec<String>

Path to used item(s)

is_external: bool

Comes from external crate

rename: Option<String>

Optional as

Quote

A Quote node is inserted by phase TransformHaxLibInline to deal with some hax_lib features. For example insertion of verbatim backend code.

Fields

quote: Quote

Content of the quote

origin: ItemQuoteOrigin

Description of the quote target position

RustModule

A Rust module (mod, inline or not). This exists solely because modules can have attributes relevant to the hax engine.

Error(ErrorNode)

Fallback constructor to carry errors.

Resugared(ResugaredItemKind)

A resugared item. This variant is introduced before printing only. Phases must not produce this variant.

NotImplementedYet

Item that is not implemented yet

Implementations

impl ItemKind

pub fn promote(self, ident: GlobalId, span: Span) -> Item

Promote to an item

Trait Implementations

impl AnyFragment for ItemKind

fn type_id() -> FragmentTypeId

Get a type identifier for this fragment.

fn as_fragment<'a>(&'a self, type_id: FragmentTypeId) -> Option<FragmentRef<'a>>

Coerce as a fragment reference.

fn as_owned_fragment(&self, type_id: FragmentTypeId) -> Option<Fragment>

Coerce as an owned fragment.

impl AstVisitable for ItemKind

fn drive_map<V: AstVisitorMut>(&mut self, v: &mut V)

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive<V: AstVisitor>(&self, v: &mut V)

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

impl AstVisitable for ItemKind

fn drive<V: AstEarlyExitVisitor>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

fn drive_mut<V: AstEarlyExitVisitorMut>( &mut self, v: &mut V, ) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.

impl Clone for ItemKind

fn clone(&self) -> ItemKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ItemKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'s, V> Drive<'s, V> for ItemKind

where V: Visitor + Visit<'s, GlobalId> + Visit<'s, Generics> + Visit<'s, Expr> + Visit<'s, Vec<Param>> + Visit<'s, SafetyKind> + Visit<'s, Ty> + Visit<'s, Vec<Variant>> + Visit<'s, bool> + Visit<'s, Vec<TraitItem>> + Visit<'s, (GlobalId, Vec<GenericValue>)> + Visit<'s, Vec<ImplItem>> + Visit<'s, Vec<(ImplExpr, ImplIdent)>> + Visit<'s, Vec<String>> + Visit<'s, Option<String>> + Visit<'s, Quote> + Visit<'s, ItemQuoteOrigin> + Visit<'s, ErrorNode> + Visit<'s, ResugaredItemKind>,

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl<'s, V> DriveMut<'s, V> for ItemKind

where V: Visitor + VisitMut<'s, GlobalId> + VisitMut<'s, Generics> + VisitMut<'s, Expr> + VisitMut<'s, Vec<Param>> + VisitMut<'s, SafetyKind> + VisitMut<'s, Ty> + VisitMut<'s, Vec<Variant>> + VisitMut<'s, bool> + VisitMut<'s, Vec<TraitItem>> + VisitMut<'s, (GlobalId, Vec<GenericValue>)> + VisitMut<'s, Vec<ImplItem>> + VisitMut<'s, Vec<(ImplExpr, ImplIdent)>> + VisitMut<'s, Vec<String>> + VisitMut<'s, Option<String>> + VisitMut<'s, Quote> + VisitMut<'s, ItemQuoteOrigin> + VisitMut<'s, ErrorNode> + VisitMut<'s, ResugaredItemKind>,

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.

impl Eq for ItemKind

impl<'lt> From<&'lt ItemKind> for FragmentRef<'lt>

fn from(fragment: &'lt ItemKind) -> Self

Converts to this type from the input type.

impl From<ItemKind> for Fragment

fn from(fragment: ItemKind) -> Self

Converts to this type from the input type.

impl Hash for ItemKind

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 JsonSchema for ItemKind

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for ItemKind

fn cmp(&self, other: &ItemKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ItemKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ItemKind

fn partial_cmp(&self, other: &ItemKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ItemKind

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ItemKind

impl<A: 'static + Clone, P: PrettyAst<A>> ToDocument<P, A> for ItemKind

fn to_document(&self, printer: &P) -> DocBuilder<A>

Produce a document using the provided printer reference.