Struct SourceFile 

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

Per-file salsa input. A new revision is observed whenever text is set.

uri is the LSP document URI as a string (e.g. file:///path/Foo.php). It lives on the input so that tracked queries like file_refs can emit per-symbol location records keyed by URI without needing a separate FileId→URI map outside salsa.

cached_slice (Phase K2): when Some, holds a pre-computed StubSlice loaded from the on-disk cache. file_definitions checks this field first and returns the cached slice instead of parsing + running DefinitionCollector. Cleared back to None on any text edit — see DocumentStore::mirror_text — so a stale cached slice cannot mask a real change. Seeded by workspace scan via DocumentStore::seed_cached_slice before the first file_definitions call for that file.

Implementations

impl SourceFile

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

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

impl SourceFile

pub fn new<Db_>( db: &Db_, id: FileId, uri: Arc<str>, text: Arc<str>, cached_slice: Option<Arc<StubSlice>>, ) -> Self

where Db_: ?Sized + Database,

pub fn builder( id: FileId, uri: Arc<str>, text: Arc<str>, cached_slice: Option<Arc<StubSlice>>, ) -> <Self as HasBuilder>::Builder

pub fn id<'db, Db_>(self, db: &'db Db_) -> FileId

where Db_: ?Sized + Database,

pub fn uri<'db, Db_>(self, db: &'db Db_) -> Arc<str>

where Db_: ?Sized + Database,

pub fn text<'db, Db_>(self, db: &'db Db_) -> Arc<str>

where Db_: ?Sized + Database,

pub fn cached_slice<'db, Db_>(self, db: &'db Db_) -> Option<Arc<StubSlice>>

where Db_: ?Sized + Database,

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

where Db_: ?Sized + Database,

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

where Db_: ?Sized + Database,

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

where Db_: ?Sized + Database,

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

where Db_: ?Sized + Database,

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

where for<'__trivial_bounds> FileId: Debug, for<'__trivial_bounds, '__trivial_bounds> Arc<str>: Debug, for<'__trivial_bounds> Option<Arc<StubSlice>>: Debug,

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

Trait Implementations

impl AsId for SourceFile

fn as_id(&self) -> Id

impl Clone for SourceFile

fn clone(&self) -> SourceFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for SourceFile

const LOCATION: Location

const DEBUG_NAME: &'static str = "SourceFile"

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 = SourceFile

The input struct (which wraps an Id)

type Fields = (FileId, Arc<str>, Arc<str>, Option<Arc<StubSlice>>)

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

type Revisions = [Revision; 4]

type Durabilities = [Durability; 4]

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.

fn heap_size(_value: &Self::Fields) -> Option<usize>

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

impl FromId for SourceFile

fn from_id(id: Id) -> Self

impl HasBuilder for SourceFile

type Builder = Builder_

impl HasJar for SourceFile

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

The [JarKind] for Self::Jar.

type Jar = JarImpl<SourceFile>

The [Jar] associated with this ingredient.

impl Hash for SourceFile

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 PartialEq for SourceFile

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

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 Update for SourceFile

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

Returns

impl Copy for SourceFile

impl Eq for SourceFile

impl StructuralPartialEq for SourceFile