Struct Unpack 

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

This ingredient represents a single unpacking.

This is required to make use of salsa to cache the complete unpacking of multiple variables involved. It allows us to:

1. Avoid doing structural match multiple times for each definition
2. Avoid highlighting the same error multiple times

Module-local type

This type should not be used as part of any cross-module API because it holds a reference to the AST node. Range-offset changes then propagate through all usages, and deserialization requires reparsing the entire module.

E.g. don’t use this type in:

• a return type of a cross-module query
• a field of a type that is a return type of a cross-module query
• an argument of a cross-module query

Implementations

impl Unpack<'static>

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

impl<'db> Unpack<'db>

pub fn new<Db_>( db: &'db Db_, program_file: ProgramFile<'db>, value_file_scope: FileScopeId, target_file_scope: FileScopeId, _target: AstNodeRef<Expr>, value: UnpackValue<'db>, ) -> Self

where Db_: ?Sized + Database,

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

where Db_: ?Sized + Database,

pub fn value<Db_>(self, db: &'db Db_) -> UnpackValue<'db>

where Db_: ?Sized + Database,

The ingredient representing the value expression of the unpacking. For example, in (a, b) = (1, 2), the value expression is (1, 2).

impl<'_db> Unpack<'_db>

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

where for<'db> ProgramFile<'db>: Debug, for<'db, 'db> FileScopeId: Debug, for<'db> AstNodeRef<Expr>: Debug, for<'db> UnpackValue<'db>: Debug,

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

impl<'db> Unpack<'db>

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

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

pub fn target<'ast>( self, db: &'db dyn Db, parsed: &'ast ParsedModuleRef, ) -> &'ast Expr

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

Returns the scope where the unpack target expression belongs to.

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

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

Returns the range of the unpack target expression.

Trait Implementations

impl AsId for Unpack<'_>

fn as_id(&self) -> Id

impl<'db> Clone for Unpack<'db>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for Unpack<'static>

const LOCATION: Location

const DEBUG_NAME: &'static str = "Unpack"

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> = (ProgramFile<'db>, FileScopeId, FileScopeId, AstNodeRef<Expr>, UnpackValue<'db>)

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

type Revisions = [AtomicRevision; 1]

type Struct<'db> = Unpack<'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 Unpack<'db>

impl Debug for Unpack<'_>

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

Formats the value using the given formatter.

impl<'db> Eq for Unpack<'db>

impl<'db> FromId for Unpack<'db>

fn from_id(id: Id) -> Self

impl GetSize for Unpack<'_>

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 Unpack<'db>

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

The [JarKind] for Self::Jar.

type Jar = JarImpl<Unpack<'static>>

The [Jar] associated with this ingredient.

impl<'db> Hash for Unpack<'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> PartialEq for Unpack<'db>

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

Equality operator ==.

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

Inequality operator !=.

impl SalsaStructInDb for Unpack<'_>

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 Unpack<'_>

impl Send for Unpack<'_>

impl<'db> StructuralPartialEq for Unpack<'db>

impl Sync for Unpack<'_>

impl TrackedStructInDb for Unpack<'_>

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

Converts the identifier for this tracked struct into a DatabaseKeyIndex.