Struct ResolverFile 

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

A file interpreted within a particular module-resolution environment.

The same file can resolve imports differently depending on the Python version and search paths used to interpret it.

For example, consider a file containing:

from zipfile._path import Path

Typeshed makes zipfile._path available only on Python 3.12 and newer:

resolve_module(ResolverFile(shared.py, Python 3.11), "zipfile._path")
    -> unresolved

resolve_module(ResolverFile(shared.py, Python 3.12), "zipfile._path")
    -> zipfile/_path/__init__.pyi

Search paths can also change which file an import resolves to, even when the Python version is identical:

resolve_module(ResolverFile(shared.py, project environment), "dependency")
    -> .venv/lib/dependency.py

resolve_module(ResolverFile(shared.py, script environment), "dependency")
    -> .script-venv/lib/dependency.py

Including the resolver environment in the file’s identity keeps these resolution results separate. Projects and scripts with equivalent resolver environments can still share resolution results.

Implementations

impl ResolverFile<'static>

pub fn ingredient(zalsa: &Zalsa) -> &IngredientImpl<Self>

impl<'db> ResolverFile<'db>

pub fn new<Db_, T0: Lookup<File> + Hash, T1: Lookup<ResolverEnvironment<'db>> + Hash>( db: &'db Db_, file: T0, environment: T1, ) -> Self

where Db_: ?Sized + Database, File: HashEqLike<T0>, ResolverEnvironment<'db>: HashEqLike<T1>,

pub fn file<Db_>(self, db: &'db Db_) -> File

where Db_: ?Sized + Database,

pub fn environment<Db_>(self, db: &'db Db_) -> ResolverEnvironment<'db>

where Db_: ?Sized + Database,

impl ResolverFile<'_>

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

where for<'db> File: Debug, for<'db> ResolverEnvironment<'db>: Debug,

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

Trait Implementations

impl<'db> AsId for ResolverFile<'db>

fn as_id(&self) -> Id

impl<'db> Clone for ResolverFile<'db>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for ResolverFile<'static>

const LOCATION: Location

const DEBUG_NAME: &'static str = "ResolverFile"

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Fields<'a> = (File, ResolverEnvironment<'a>)

The fields of the struct being interned.

type Struct<'db> = ResolverFile<'db>

The end user struct

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.

const REVISIONS: NonZero<usize> = _

impl<'db> Copy for ResolverFile<'db>

impl<'db> Debug for ResolverFile<'db>

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

Formats the value using the given formatter.

impl<'db> Eq for ResolverFile<'db>

impl<'db> FromId for ResolverFile<'db>

fn from_id(id: Id) -> Self

impl GetSize for ResolverFile<'_>

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

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

The [JarKind] for Self::Jar.

type Jar = JarImpl<ResolverFile<'static>>

The [Jar] associated with this ingredient.

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

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

Equality operator ==.

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

Inequality operator !=.

impl<'db> SalsaStructInDb for ResolverFile<'db>

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<'db> SalsaValue for ResolverFile<'db>

impl<'db> Send for ResolverFile<'db>

impl<'db> StructuralPartialEq for ResolverFile<'db>

impl<'db> Sync for ResolverFile<'db>