Enum Decl

pub enum Decl {
    Func(SpannedDecl),
    ImportAlias(SpannedDecl),
    Var(SpannedDecl),
    IdentRef(SpannedDecl),
    Module(ModuleDecl),
    ModuleAlias(SpannedDecl),
    PathStem(SpannedDecl),
    ImportPath(SpannedDecl),
    IncludePath(SpannedDecl),
    Import(SpannedDecl),
    ContentRef(SpannedDecl),
    Label(SpannedDecl),
    StrName(SpannedDecl),
    ModuleImport(SpanDecl),
    Closure(SpanDecl),
    Pattern(SpanDecl),
    Spread(SpanDecl),
    Content(SpanDecl),
    Constant(SpanDecl),
    BibEntry(NameRangeDecl),
    Docs(DocsDecl),
    Generated(GeneratedDecl),
}

Represents different kinds of declarations in the language.

Variants

Func(SpannedDecl)

A function declaration: (x, y) => x + y

ImportAlias(SpannedDecl)

An import alias declaration: import "path.typ": x

Var(SpannedDecl)

A variable declaration: let x = 1

IdentRef(SpannedDecl)

An identifier reference declaration: x

Module(ModuleDecl)

A module declaration: import calc

ModuleAlias(SpannedDecl)

A module alias declaration: import "path.typ" as x

PathStem(SpannedDecl)

A path stem declaration: path.typ

ImportPath(SpannedDecl)

An import path declaration: import "path.typ"

IncludePath(SpannedDecl)

An include path declaration: include "path.typ"

Import(SpannedDecl)

An import declaration: import "path.typ"

ContentRef(SpannedDecl)

A content reference declaration: @x

Label(SpannedDecl)

A label declaration: label

StrName(SpannedDecl)

A string name declaration: "x"

ModuleImport(SpanDecl)

A module import declaration: import "path.typ": *

Closure(SpanDecl)

A closure declaration: (x, y) => x + y

Pattern(SpanDecl)

A pattern declaration: let (x, y, ..z) = 1

Spread(SpanDecl)

A spread declaration: ..z

Content(SpanDecl)

A content declaration: #[text]

Constant(SpanDecl)

A constant declaration: let x = 1

BibEntry(NameRangeDecl)

A bib entry declaration: @entry

Docs(DocsDecl)

A docs declaration created by the compiler.

Generated(GeneratedDecl)

A generated declaration created by the compiler.

Implementations

impl Decl

pub fn name(&self) -> &Interned<str>

Gets the name of the item.

pub fn span(&self) -> Span

Gets the span of the item.

impl Decl

pub fn func(ident: Ident<'_>) -> Self

Creates a function declaration from an identifier.

pub fn lit(name: &str) -> Self

Creates a variable declaration from a string literal.

pub fn lit_(name: Interned<str>) -> Self

Creates a variable declaration from an interned string.

pub fn var(ident: Ident<'_>) -> Self

Creates a variable declaration from an identifier.

pub fn import_alias(ident: Ident<'_>) -> Self

Creates an import alias declaration from an identifier.

pub fn ident_ref(ident: Ident<'_>) -> Self

Creates an identifier reference declaration from an identifier.

pub fn math_ident_ref(ident: MathIdent<'_>) -> Self

Creates an identifier reference declaration from a math identifier.

pub fn module(fid: TypstFileId) -> Self

Creates a module declaration with a file ID.

pub fn module_with_name(name: Interned<str>, fid: TypstFileId) -> Self

Creates a module declaration with a name and a file ID.

pub fn module_alias(ident: Ident<'_>) -> Self

Creates a module alias declaration from an identifier.

pub fn import(ident: Ident<'_>) -> Self

Creates an import declaration from an identifier.

pub fn label(name: &str, at: Span) -> Self

Creates a label declaration with a name and span.

pub fn ref_(ident: Ref<'_>) -> Self

Creates a content reference declaration from a reference AST node.

pub fn str_name(s: SyntaxNode, name: &str) -> Decl

Creates a string name declaration from a syntax node and name.

pub fn calc_path_stem(s: &str) -> Interned<str>

Calculates the path stem from a string path or package specification.

For package specs (starting with ‘@’), extracts the package name. For file paths, extracts the file stem. Returns empty string if extraction fails.

pub fn path_stem(s: SyntaxNode, name: Interned<str>) -> Self

Creates a path stem declaration from a syntax node and name.

pub fn import_path(s: Span, name: Interned<str>) -> Self

Creates an import path declaration with a span and name.

pub fn include_path(s: Span, name: Interned<str>) -> Self

Creates an include path declaration with a span and name.

pub fn module_import(s: Span) -> Self

Creates a module import declaration with just a span.

pub fn closure(s: Span) -> Self

Creates a closure declaration with just a span.

pub fn pattern(s: Span) -> Self

Creates a pattern declaration with just a span.

pub fn spread(s: Span) -> Self

Creates a spread declaration with just a span.

pub fn content(s: Span) -> Self

Creates a content declaration with just a span.

pub fn constant(s: Span) -> Self

Creates a constant declaration with just a span.

pub fn docs(base: Interned<Decl>, var: Interned<TypeVar>) -> Self

Creates a documentation declaration linking a base declaration with a type variable.

pub fn generated(def_id: DefId) -> Self

Creates a generated declaration with a definition ID.

pub fn bib_entry( name: Interned<str>, fid: TypstFileId, name_range: Range<usize>, range: Option<Range<usize>>, ) -> Self

Creates a bibliography entry declaration.

pub fn is_def(&self) -> bool

Checks if this declaration represents a definition rather than a reference (usage of a definition).

pub fn kind(&self) -> DefKind

Returns the kind of definition this declaration represents.

pub fn file_id(&self) -> Option<TypstFileId>

Gets file location of the declaration.

pub fn full_range(&self) -> Option<Range<usize>>

Gets full range of the declaration.

pub fn as_def(this: &Interned<Self>, val: Option<Ty>) -> Interned<RefExpr>

Creates a reference expression that points to this declaration.

impl Decl

pub fn strict_cmp(&self, other: &Self) -> Ordering

Low-performance comparison that is free from concurrency issues.

Trait Implementations

impl Clone for Decl

fn clone(&self) -> Decl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decl

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

Formats the value using the given formatter.

impl From<Decl> for Expr

fn from(decl: Decl) -> Self

Converts to this type from the input type.

impl Hash for Decl

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 Internable for Decl

fn storage() -> &'static InternStorage<Self>

impl Ord for Decl

fn cmp(&self, other: &Self) -> 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 Decl

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

fn partial_cmp(&self, other: &Self) -> 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 Eq for Decl

impl StructuralPartialEq for Decl