Enum DefinitionKind 

pub enum DefinitionKind<'db> {
    Import(ImportDefinitionKind),
    ImportFrom(ImportFromDefinitionKind),
    ImportFromSubmodule(ImportFromSubmoduleDefinitionKind),
    StarImport(StarImportDefinitionKind),
    Function(AstNodeRef<StmtFunctionDef>),
    Class(AstNodeRef<StmtClassDef>),
    TypeAlias(AstNodeRef<StmtTypeAlias>),
    NamedExpression(AstNodeRef<ExprNamed>),
    Assignment(AssignmentDefinitionKind<'db>),
    AnnotatedAssignment(AnnotatedAssignmentDefinitionKind),
    AugmentedAssignment(AstNodeRef<StmtAugAssign>),
    DictKeyAssignment(DictKeyAssignmentKind<'db>),
    For(ForStmtDefinitionKind<'db>),
    Comprehension(ComprehensionDefinitionKind<'db>),
    Parameter(ParameterDefinitionNodeKind),
    LambdaParameter(LambdaParameterDefinitionNodeKind),
    WithItem(WithItemDefinitionKind<'db>),
    MatchPattern(MatchPatternDefinitionKind<'db>),
    ExceptHandler(ExceptHandlerDefinitionKind),
    TypeVar(AstNodeRef<TypeParamTypeVar>),
    ParamSpec(AstNodeRef<TypeParamParamSpec>),
    TypeVarTuple(AstNodeRef<TypeParamTypeVarTuple>),
    LoopHeader(LoopHeaderDefinitionKind),
    NestedBindings(Box<NestedBindingsDefinitionKind>),
}

The kind of a definition.

Usage in salsa tracked structs

DefinitionKind fields in salsa tracked structs should be tracked (attributed with #[tracked]) because the kind is a thin wrapper around AstNodeRef. See the AstNodeRef documentation for an in-depth explanation of why this is necessary.

Variants

Import(ImportDefinitionKind)

ImportFrom(ImportFromDefinitionKind)

ImportFromSubmodule(ImportFromSubmoduleDefinitionKind)

StarImport(StarImportDefinitionKind)

Function(AstNodeRef<StmtFunctionDef>)

Class(AstNodeRef<StmtClassDef>)

TypeAlias(AstNodeRef<StmtTypeAlias>)

NamedExpression(AstNodeRef<ExprNamed>)

Assignment(AssignmentDefinitionKind<'db>)

AnnotatedAssignment(AnnotatedAssignmentDefinitionKind)

AugmentedAssignment(AstNodeRef<StmtAugAssign>)

DictKeyAssignment(DictKeyAssignmentKind<'db>)

For(ForStmtDefinitionKind<'db>)

Comprehension(ComprehensionDefinitionKind<'db>)

Parameter(ParameterDefinitionNodeKind)

LambdaParameter(LambdaParameterDefinitionNodeKind)

WithItem(WithItemDefinitionKind<'db>)

MatchPattern(MatchPatternDefinitionKind<'db>)

ExceptHandler(ExceptHandlerDefinitionKind)

TypeVar(AstNodeRef<TypeParamTypeVar>)

ParamSpec(AstNodeRef<TypeParamParamSpec>)

TypeVarTuple(AstNodeRef<TypeParamTypeVarTuple>)

LoopHeader(LoopHeaderDefinitionKind)

NestedBindings(Box<NestedBindingsDefinitionKind>)

Implementations

impl<'db> DefinitionKind<'db>

pub const fn as_star_import(&self) -> Option<&StarImportDefinitionKind>

pub const fn as_class(&self) -> Option<&AstNodeRef<StmtClassDef>>

pub fn is_import(&self) -> bool

pub const fn is_unannotated_assignment(&self) -> bool

pub const fn is_function_def(&self) -> bool

pub const fn is_parameter_def(&self) -> bool

pub const fn is_loop_header(&self) -> bool

pub const fn is_user_visible(&self) -> bool

Returns true if this definition is user-visible (i.e., not an internal synthetic definition like a loop header or nested bindings definition).

pub fn target_range(&self, module: &ParsedModuleRef) -> TextRange

Returns the TextRange of the definition target.

A definition target would mainly be the node representing the place being defined i.e., ast::ExprName, ast::Identifier, ast::ExprAttribute or ast::ExprSubscript but could also be other nodes.

pub fn full_range(&self, module: &ParsedModuleRef) -> TextRange

Returns the TextRange of the entire definition.

pub fn category( &self, in_stub: bool, module: &ParsedModuleRef, ) -> DefinitionCategory

pub fn value<'ast>(&self, module: &'ast ParsedModuleRef) -> Option<&'ast Expr>

Returns the value expression for assignment-based definitions.

Returns Some for Assignment and AnnotatedAssignment (if it has a value), None for all other definition kinds.

Trait Implementations

impl<'db> Clone for DefinitionKind<'db>

fn clone(&self) -> DefinitionKind<'db>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'db> Debug for DefinitionKind<'db>

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

Formats the value using the given formatter.

impl<'db> GetSize for DefinitionKind<'db>

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<TRACKER: GetSizeTracker>( &self, tracker: TRACKER, ) -> (usize, TRACKER)

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl<'db> SalsaValue for DefinitionKind<'db>