Enum Module 

pub enum Module<'db> {
    File(FileModule<'db>),
    Namespace(NamespacePackage<'db>),
}

Representation of a Python module.

Variants

File(FileModule<'db>)

Namespace(NamespacePackage<'db>)

Implementations

impl<'db> Module<'db>

pub fn name(self, db: &'db dyn Database) -> &'db ModuleName

The absolute name of the module (e.g. foo.bar)

pub fn file(self, db: &'db dyn Database) -> Option<File>

The file to the source code that defines this module

This is None for namespace packages.

pub fn known(self, db: &'db dyn Database) -> Option<KnownModule>

Is this a module that we special-case somehow? If so, which one?

pub fn is_known(self, db: &'db dyn Database, known_module: KnownModule) -> bool

Does this module represent the given known module?

pub fn search_path(self, db: &'db dyn Database) -> Option<&'db SearchPath>

The search path from which the module was resolved.

It is guaranteed that if None is returned, then this is a namespace package. Otherwise, this is a regular package or file module.

pub fn kind(self, db: &'db dyn Database) -> ModuleKind

Determine whether this module is a single-file module or a package

pub fn all_submodules(self, db: &'db dyn Db) -> &'db [Module<'db>]

Return a list of all submodules of this module.

Returns an empty list if the module is not a package, if it is an empty package, or if it is a namespace package (one without an __init__.py or __init__.pyi file).

The names returned correspond to the “base” name of the module. That is, {self.name}.{basename} should give the full module name.

Trait Implementations

impl<'db> AsId for Module<'db>

fn as_id(&self) -> Id

impl<'db> Clone for Module<'db>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'db> Copy for Module<'db>

impl Debug for Module<'_>

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

Formats the value using the given formatter.

impl<'db> Eq for Module<'db>

impl<'db> FromIdWithDb for Module<'db>

fn from_id(__id: Id, zalsa: &Zalsa) -> Self

impl GetSize for Module<'_>

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

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

const LEAF_TYPE_IDS: &'static [ConstTypeId]

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

type MemoIngredientMap = MemoIngredientIndices

fn lookup_ingredient_index(__zalsa: &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> StructuralPartialEq for Module<'db>

impl<'db> Update for Module<'db>

unsafe fn maybe_update(old_pointer_: *mut Self, new_value_: Self) -> bool

Returns