Skip to main content

Shape

Enum Shape 

Source
pub enum Shape {
Show 22 variants Function, Method, Closure, Record, Impl, Block, Loop, Branch, Match, MatchArm, Call, Assign, VarDecl, Return, Break, Continue, Try, ExprStmt, MacroDef, MacroCall, Error, Native(Lexeme),
}
Expand description

The cross-language shape vocabulary.

Every variant except Shape::Native means the same thing in all three languages, so structural comparison across files (and, in later phases, across languages) can work on shapes alone. A frontend maps its grammar onto these; whatever does not fit is carried as Shape::Native with the grammar’s own kind name preserved.

Variants§

§

Function

A free function definition.

§

Method

A method definition (function inside an impl/class/struct body).

§

Closure

A closure or lambda.

§

Record

A record definition: struct, class, union or enum.

§

Impl

An implementation or member-definition container (impl, class body).

§

Block

A braced statement block.

§

Loop

A loop of any flavour (for, while, loop, do-while).

§

Branch

A two-way conditional (if/else chain member).

§

Match

A multi-way conditional (match, switch).

§

MatchArm

One arm of a multi-way conditional.

§

Call

A function, method or macro-like call expression.

§

Assign

An assignment or compound assignment.

§

VarDecl

A local variable declaration (let, C/C++ declaration statement).

§

Return

A return (or expression-position tail return).

§

Break

An early loop exit (break).

§

Continue

A loop continuation (continue).

§

Try

Error propagation or handling (? operator, try/catch).

§

ExprStmt

An expression used as a statement, not covered by a finer shape.

§

MacroDef

A macro or preprocessor definition site.

§

MacroCall

A macro invocation site (not expanded).

§

Error

A region the parser could not interpret. Children may still be intact.

§

Native(Lexeme)

A node kept under its native grammar kind because no common shape applies. The kind name takes part in structural comparison, so two native nodes match only when their grammars call them the same thing.

Implementations§

Source§

impl Shape

Source

pub const fn tag(&self) -> u8

A stable one-byte tag for this shape, for use as fingerprint input.

For Shape::Native the tag alone is not sufficient input: the native kind name must be hashed alongside it, or all native nodes would collapse into one shape.

Source

pub const fn introduces_scope(&self) -> bool

Whether this shape opens a lexical scope for alpha renaming.

This is the structural basis normalization uses to rename identifiers consistently within — and only within — one scope. The judgement is syntactic and shared by all three languages: bodies bind, containers and single statements do not.

Source

pub const fn is_statement(&self) -> bool

Whether nodes of this shape are statements for the purposes of statement sequences and statement-window fragments.

Trait Implementations§

Source§

impl Clone for Shape

Source§

fn clone(&self) -> Shape

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Shape

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Shape

Source§

impl PartialEq for Shape

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Shape

Auto Trait Implementations§

§

impl Freeze for Shape

§

impl RefUnwindSafe for Shape

§

impl Send for Shape

§

impl Sync for Shape

§

impl Unpin for Shape

§

impl UnsafeUnpin for Shape

§

impl UnwindSafe for Shape

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.