Struct File 

pub struct File(/* private fields */);

A file-system path that’s either stored on the host system’s file system or in the vendored file system.

Ordering

Ordering is based on the file’s salsa-assigned id and not on its values. The id may change between runs.

Implementations

impl File

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

pub fn ingredient_mut( zalsa_mut: &mut Zalsa, ) -> (&mut IngredientImpl<Self>, &mut Runtime)

impl File

pub fn new<Db_>(db: &Db_, path: FilePath) -> Self

where Db_: ?Sized + Database,

pub fn builder(path: FilePath) -> <Self as HasBuilder>::Builder

pub fn path<'db, Db_>(self, db: &'db Db_) -> &'db FilePath

where Db_: ?Sized + Database,

The path of the file (immutable).

pub fn permissions<'db, Db_>(self, db: &'db Db_) -> Option<u32>

where Db_: ?Sized + Database,

The unix permissions of the file. Only supported on unix systems. Always None on Windows or when the file has been deleted.

pub fn revision<'db, Db_>(self, db: &'db Db_) -> FileRevision

where Db_: ?Sized + Database,

The path revision. A file or directory has changed if the revisions don’t compare equal.

pub fn status<'db, Db_>(self, db: &'db Db_) -> FileStatus

where Db_: ?Sized + Database,

The status of the file.

Salsa doesn’t support deleting inputs. The only way to signal dependent queries that the file has been deleted is to change the status to Deleted.

pub fn source_text_override<'db, Db_>( self, db: &'db Db_, ) -> &'db Option<SourceText>

where Db_: ?Sized + Database,

Overrides the result of source_text.

This is useful when running queries after modifying a file’s content but before the content is written to disk. For example, to verify that the applied fixes didn’t introduce any new errors.

The override gets automatically removed the next time the file changes.

pub fn set_path<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = FilePath> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_permissions<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<u32>> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_revision<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = FileRevision> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_status<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = FileStatus> + use<'db, Db_>

where Db_: ?Sized + Database,

pub fn set_source_text_override<'db, Db_>( self, db: &'db mut Db_, ) -> impl Setter<FieldTy = Option<SourceText>> + use<'db, Db_>

where Db_: ?Sized + Database,

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

where for<'__trivial_bounds> FilePath: Debug, for<'__trivial_bounds> Option<u32>: Debug, for<'__trivial_bounds> FileRevision: Debug, for<'__trivial_bounds> FileStatus: Debug, for<'__trivial_bounds> Option<SourceText>: Debug,

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

impl File

pub fn read_to_string(&self, db: &dyn Db) -> Result<String>

Reads the content of the file into a String.

Reading the same file multiple times isn’t guaranteed to return the same content. It’s possible that the file has been modified in between the reads.

pub fn read_to_notebook(&self, db: &dyn Db) -> Result<Notebook, NotebookError>

Reads the content of the file into a Notebook.

Reading the same file multiple times isn’t guaranteed to return the same content. It’s possible that the file has been modified in between the reads.

pub fn sync_path(db: &mut dyn Db, path: &SystemPath)

Refreshes the file metadata by querying the file system if needed.

Directory listings are invalidated if the path’s file status changed, its prior status is unknown, or if path is itself a directory.

pub fn sync_path_only(db: &mut dyn Db, path: &SystemPath)

Refreshes only the file metadata by querying the file system if needed.

This specifically does not invalidate any directory listings.

pub fn sync_virtual_path(db: &mut dyn Db, path: &SystemVirtualPath)

Increments the revision for the virtual file at path.

pub fn sync(self, db: &mut dyn Db)

Syncs the File’s state with the state of the file on the system.

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

Returns true if the file exists.

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

Returns true if the file should be analyzed as a type stub.

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

Returns true if the file is an __init__.pyi

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

Returns true if the file is an __init__.pyi

pub fn source_type(self, db: &dyn Db) -> PySourceType

Trait Implementations

impl AsId for File

fn as_id(&self) -> Id

impl Clone for File

fn clone(&self) -> File

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for File

const LOCATION: Location

const DEBUG_NAME: &'static str = "File"

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

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Singleton = NotSingleton

The singleton state for this input if any.

type Struct = File

The input struct (which wraps an Id)

type Fields = (FilePath, Option<u32>, FileRevision, FileStatus, Option<SourceText>)

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

type Revisions = [Revision; 5]

type Durabilities = [Durability; 5]

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, D::Error>

Deserialize the fields using serde.

impl Copy for File

impl Debug for File

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

Formats the value using the given formatter.

impl Eq for File

impl From<File> for Span

fn from(file: File) -> Span

Converts to this type from the input type.

impl FromId for File

fn from_id(id: Id) -> Self

impl GetSize for File

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 HasBuilder for File

type Builder = Builder_

impl HasJar for File

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

The [JarKind] for Self::Jar.

type Jar = JarImpl<File>

The [Jar] associated with this ingredient.

impl Hash for File

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 Ord for File

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

impl PartialEq for File

fn eq(&self, other: &File) -> 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 PartialOrd for File

fn partial_cmp(&self, other: &File) -> 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 File

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 StructuralPartialEq for File

impl Update for File

unsafe fn maybe_update(old_pointer: *mut Self, new_value: Self) -> bool

Returns