Struct Definition 

pub struct Definition<'db>(/* private fields */);

A definition of a place.

ID stability

The Definition’s ID is stable when the only field that change is its kind (AST node).

The Definition changes when the file, scope, or place change. This can be because a new scope gets inserted before the Definition or a new place is inserted before this Definition. However, the ID can be considered stable and it is okay to use Definition in cross-module` salsa queries or as a field on other salsa tracked structs.

Implementations

impl Definition<'static>

pub fn ingredient(db: &dyn Database) -> &IngredientImpl<Self>

impl<'db> Definition<'db>

pub fn new_internal<Db_>( db: &'db Db_, scope_id: ScopeId<'db>, place_info: DefinitionPlace, kind: DefinitionKind<'db>, ) -> Self

where Db_: ?Sized + Database,

pub fn kind<Db_>(self, db: &'db Db_) -> &'db DefinitionKind<'db>

where Db_: ?Sized + Database,

WARNING: Only access this field when doing type inference for the same file as where Definition is defined to avoid cross-file query dependencies.

pub fn scope_id<Db_>(self, db: &'db Db_) -> ScopeId<'db>

where Db_: ?Sized + Database,

The scope in which the definition occurs.

Storing the interned scope avoids retaining the file and file-local scope separately, at the cost of database lookups when either of those values is needed.

impl<'_db> Definition<'_db>

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'db> ScopeId<'db>: Debug, for<'db> DefinitionPlace: Debug, for<'db> DefinitionKind<'db>: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

impl<'db> Definition<'db>

pub fn scope(self, db: &'db dyn Db) -> ScopeId<'db>

pub fn file(self, db: &'db dyn Db) -> File

pub fn python_file(self, db: &'db dyn Db) -> PythonFile<'db>

pub fn program_file(self, db: &'db dyn Db) -> ProgramFile<'db>

pub fn program(self, db: &'db dyn Db) -> Program<'db>

pub fn file_scope(self, db: &'db dyn Db) -> FileScopeId

pub fn place(self, db: &'db dyn Db) -> ScopedPlaceId

pub fn is_reexported(self, db: &'db dyn Db) -> bool

pub fn full_range(self, db: &'db dyn Db, module: &ParsedModuleRef) -> FileRange

pub fn focus_range(self, db: &'db dyn Db, module: &ParsedModuleRef) -> FileRange

pub fn name(self, db: &'db dyn Db) -> Option<String>

Returns the name of the item being defined, if applicable.

pub fn docstring(self, db: &'db dyn Db) -> Option<String>

Extract a docstring from this definition, if applicable. This method returns a docstring for function, class, and attribute definitions. The docstring is extracted from the first statement in the body if it’s a string literal.

Trait Implementations

impl AsId for Definition<'_>

fn as_id(&self) -> Id

impl<'db> Clone for Definition<'db>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for Definition<'static>

const LOCATION: Location

const DEBUG_NAME: &'static str = "Definition"

The debug name of the tracked struct.

const TRACKED_FIELD_NAMES: &'static [&'static str]

The debug names of any tracked fields.

const TRACKED_FIELD_INDICES: &'static [usize]

The relative indices of any tracked fields.

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Fields<'db> = (ScopeId<'db>, DefinitionPlace, DefinitionKind<'db>)

A (possibly empty) tuple of the fields for this struct.

type Revisions = [AtomicRevision; 1]

type Struct<'db> = Definition<'db>

fn untracked_fields(fields: &Self::Fields<'_>) -> impl Hash

fn new_revisions(current_revision: Revision_) -> Self::Revisions

Create a new value revision array where each element is set to current_revision.

fn update_fields<'db>( current_revision: Revision_, revisions: &Self::Revisions, old_fields: &mut Self::Fields<'db>, new_fields: Self::Fields<'db>, ) -> bool

Update the field data and, if the value has changed, the appropriate entry in the revisions array (tracked fields only).

fn heap_size(value: &Self::Fields<'_>) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

fn serialize<S: Serializer>( fields: &Self::Fields<'_>, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

fn deserialize<'de, D: Deserializer<'de>>( deserializer: D, ) -> Result<Self::Fields<'static>, D::Error>

Deserialize the fields using serde.

impl<'db> Copy for Definition<'db>

impl Debug for Definition<'_>

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

Formats the value using the given formatter.

impl<'db> Eq for Definition<'db>

impl<'db> FromId for Definition<'db>

fn from_id(id: Id) -> Self

impl GetSize for Definition<'_>

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

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

where T: GetSizeTracker,

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

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> HasJar for Definition<'db>

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<Definition<'static>>

The [Jar] associated with this ingredient.

impl<'db> Hash for Definition<'db>

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<'db> Ord for Definition<'db>

fn cmp(&self, other: &Definition<'db>) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<'db> PartialEq for Definition<'db>

fn eq(&self, other: &Definition<'db>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'db> PartialOrd for Definition<'db>

fn partial_cmp(&self, other: &Definition<'db>) -> 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 SalsaStructInDb for Definition<'_>

const LEAF_TYPE_IDS: &'static [ConstTypeId]

The type IDs of all concrete (leaf) salsa struct types that this type can contain.

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl SalsaValue for Definition<'_>

impl Send for Definition<'_>

impl<'db> StructuralPartialEq for Definition<'db>

impl Sync for Definition<'_>

impl TrackedStructInDb for Definition<'_>

fn database_key_index(zalsa: &Zalsa, id: Id) -> DatabaseKeyIndex

Converts the identifier for this tracked struct into a DatabaseKeyIndex.