Struct lark_query_system::LarkDatabase

pub struct LarkDatabase { /* fields omitted */ }

Methods

impl LarkDatabase

pub fn intern_string(&self, s: &str) -> GlobalIdentifier

pub fn untern_string(&self, id: GlobalIdentifier) -> Text

Trait Implementations

impl LsDatabase for LarkDatabase

fn check_for_cancellation(&self) -> Cancelable<()>

fn errors_for_project(
    &self
) -> Cancelable<HashMap<String, Vec<RangedDiagnostic>>>

fn range(&self, span: Span<FileName>) -> Range

fn accumulate_errors_for_entity(
    &self,
    entity: Entity,
    errors: &mut Vec<Diagnostic>
) -> Cancelable<()>

fn find_all_references_to_definition(
    &self,
    definition_entity: Entity
) -> Vec<(String, Range)>

fn find_all_references_to_variable(
    &self,
    fn_body: &FnBody,
    variable: Variable
) -> Vec<(String, Range)>

fn find_all_references_to_field(
    &self,
    field_entity: Entity
) -> Vec<(String, Range)>

fn rename_all_references_at_position(
    &self,
    url: &str,
    position: Position,
    new_name: &str
) -> Cancelable<Vec<(String, Range, String)>>

fn find_all_references_at_position(
    &self,
    url: &str,
    position: Position
) -> Cancelable<Vec<(String, Range)>>

fn get_entity_span_if_possible(
    &self,
    entity: Entity,
    use_minimal_span: bool
) -> Option<Span<FileName>>

fn definition_range_at_position(
    &self,
    url: &str,
    position: Position,
    minimal_span: bool
) -> Cancelable<Option<(String, Range)>>

fn hover_text_at_position(
    &self,
    url: &str,
    position: Position
) -> Cancelable<Option<String>>

Returns the hover text to display for a given position (if any).

fn position_to_byte_index(&self, url: &str, position: Position) -> ByteIndex

impl AsRef<EntityTables> for LarkDatabase

fn as_ref(&self) -> &EntityTables

Performs the conversion.

impl AsRef<GlobalIdentifierTables> for LarkDatabase

fn as_ref(&self) -> &GlobalIdentifierTables

Performs the conversion.

impl AsRef<DeclarationTables> for LarkDatabase

fn as_ref(&self) -> &DeclarationTables

Performs the conversion.

impl AsRef<BaseInferredTables> for LarkDatabase

fn as_ref(&self) -> &BaseInferredTables

Performs the conversion.

impl AsRef<FullInferredTables> for LarkDatabase

fn as_ref(&self) -> &FullInferredTables

Performs the conversion.

impl Default for LarkDatabase

fn default() -> Self

Returns the "default value" for a type.

impl Debug for LarkDatabase

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<'_> ReportingFiles for &'_ LarkDatabase

type Span = Span<FileName>

type FileId = FileName

fn byte_span(
    &self,
    file: Self::FileId,
    from_index: usize,
    to_index: usize
) -> Option<Self::Span>

fn file_id(&self, span: Self::Span) -> Self::FileId

fn file_name(&self, file: Self::FileId) -> FileName

fn byte_index(
    &self,
    file: Self::FileId,
    line: usize,
    column: usize
) -> Option<usize>

fn location(&self, file: Self::FileId, byte_index: usize) -> Option<Location>

fn line_span(&self, file: Self::FileId, lineno: usize) -> Option<Self::Span>

fn source(&self, span: Self::Span) -> Option<String>

impl ParserDatabase for LarkDatabase

fn file_names(&self) -> Seq<FileName>

fn file_text(&self, id: FileName) -> Text

fn entity_span(&self, entity: Entity) -> Span<FileName>

fn characteristic_entity_span(&self, entity: Entity) -> Span<FileName>

fn line_offsets(&self, id: FileName) -> Seq<usize>

Returns, for each line in the given file, the start index -- the final element is the length of the file (there is kind of a "pseudo-empty line" at the end, so to speak). So for the input "a\nb\r\nc" you would get [0, 2, 5, 6].

fn location(&self, id: FileName, index: ByteIndex) -> Location

fn byte_index(&self, id: FileName, line: u64, column: u64) -> ByteIndex

Given a (zero-based) line number line and column within the line, gives a byte-index into the file's text.

fn file_tokens(
    &self,
    id: FileName
) -> WithError<Seq<Spanned<LexToken, FileName>>>

fn parsed_file(&self, id: FileName) -> WithError<ParsedFile>

fn child_parsed_entities(&self, entity: Entity) -> WithError<Seq<ParsedEntity>>

fn parsed_entity(&self, entity: Entity) -> ParsedEntity

fn child_entities(&self, entity: Entity) -> Seq<Entity>

Returns the immediate children of entity in the entity tree.

fn descendant_entities(&self, entity: Entity) -> Seq<Entity>

Transitive closure of child_entities.

fn fn_body(&self, key: Entity) -> WithError<Arc<FnBody>>

Get the fn-body for a given def-id.

fn hover_targets(&self, file: FileName, index: ByteIndex) -> Seq<HoverTarget>

Given a span, find the things that it may have been referring to.

fn members(&self, key: Entity) -> Result<Seq<Member>, ErrorReported>

Get the list of member names and their def-ids for a given struct.

fn member_entity(
    &self,
    entity: Entity,
    kind: MemberKind,
    id: GlobalIdentifier
) -> Option<Entity>

Gets the def-id for a field of a given class.

fn ty(&self, key: Entity) -> WithError<Ty<Declaration>>

Get the type of something.

fn signature(
    &self,
    key: Entity
) -> WithError<Result<Signature<Declaration>, ErrorReported>>

Get the signature of a function.

fn generic_declarations(
    &self,
    key: Entity
) -> WithError<Result<Arc<GenericDeclarations>, ErrorReported>>

Get the generic declarations from a particular item.

fn resolve_name(&self, scope: Entity, name: GlobalIdentifier) -> Option<Entity>

Resolve a type name that appears in the given entity.

impl ParserDatabaseExt for LarkDatabase

fn init_parser_db(&mut self)

fn add_file<impl IntoFileName, impl Into>(
    &mut self,
    path: impl IntoFileName,
    contents: impl Into
) where
    impl Into: Into<Text>,
    impl IntoFileName: IntoFileName, 

fn top_level_entities_in_file<impl IntoFileName>(
    &self,
    file: impl IntoFileName
) -> Seq<Entity> where
    impl IntoFileName: IntoFileName, 

Returns the "top-level" entities defined in the given file -- does not descend to visit the children of those entities etc.

impl Database for LarkDatabase

fn salsa_runtime(&self) -> &Runtime<LarkDatabase>

Gives access to the underlying salsa runtime.

fn sweep_all(&self, strategy: SweepStrategy)

Iterates through all query storage and removes any values that have not been used since the last revision was created. The intended use-cycle is that you first execute all of your "main" queries; this will ensure that all query values they consume are marked as used. You then invoke this method to remove other values that were not needed for your main query results.

fn query<Q>(&self, query: Q) -> QueryTable<Self, Q> where
    Q: Query<Self>,
    Self: GetQueryTable<Q>, 

Get access to extra methods pertaining to a given query. For example, you can use this to run the GC (sweep) across a single input. You can also use it to invoke a query, though it's more common to use the trait method on the database itself.

fn query_mut<Q>(&mut self, query: Q) -> QueryTableMut<Self, Q> where
    Q: Query<Self>,
    Self: GetQueryTable<Q>, 

Like query, but gives access to methods for setting the value of an input.

fn salsa_event<impl Fn() -> Event>(
    &self,
    event_fn: impl Fn() -> Event
) where
    impl Fn() -> Event: Fn() -> Event<Self>, 

This function is invoked at key points in the salsa runtime. It permits the database to be customized and to inject logging or other custom behavior.

fn on_propagated_panic(&self) -> !

This function is invoked when a dependent query is being computed by the other thread, and that thread panics.

impl QueryDescriptor<LarkDatabase> for __SalsaQueryDescriptor

fn maybe_changed_since(&self, db: &LarkDatabase, revision: Revision) -> bool

Returns true if the value of this query may have changed since the given revision.

impl DatabaseStorageTypes for LarkDatabase

type QueryDescriptor = __SalsaQueryDescriptor

A "query descriptor" packages up all the possible queries and a key. It is used to store information about (e.g.) the stack.

type DatabaseStorage = LarkDatabaseStorage

Defines the "storage type", where all the query data is kept. This type is defined by the database_storage macro.

impl DatabaseOps for LarkDatabase

fn for_each_query(
    &self,
    op: impl FnMut(&dyn QueryStorageMassOps<Self>)
)

Executes the callback for each kind of query.

impl GetQueryTable<FileNamesQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, FileNamesQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, FileNamesQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <FileNamesQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<FileTextQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, FileTextQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, FileTextQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <FileTextQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<LineOffsetsQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, LineOffsetsQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, LineOffsetsQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <LineOffsetsQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<LocationQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, LocationQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, LocationQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <LocationQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ByteIndexQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ByteIndexQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, ByteIndexQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ByteIndexQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<FileTokensQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, FileTokensQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, FileTokensQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <FileTokensQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ParsedFileQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ParsedFileQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, ParsedFileQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ParsedFileQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ChildParsedEntitiesQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ChildParsedEntitiesQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(
    db: &mut Self
) -> QueryTableMut<Self, ChildParsedEntitiesQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ChildParsedEntitiesQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ParsedEntityQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ParsedEntityQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, ParsedEntityQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ParsedEntityQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ChildEntitiesQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ChildEntitiesQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, ChildEntitiesQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ChildEntitiesQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<FnBodyQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, FnBodyQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, FnBodyQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <FnBodyQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<HoverTargetsQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, HoverTargetsQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, HoverTargetsQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <HoverTargetsQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<MembersQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, MembersQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, MembersQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <MembersQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<MemberEntityQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, MemberEntityQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, MemberEntityQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <MemberEntityQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<DescendantEntitiesQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, DescendantEntitiesQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(
    db: &mut Self
) -> QueryTableMut<Self, DescendantEntitiesQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <DescendantEntitiesQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<EntitySpanQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, EntitySpanQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, EntitySpanQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <EntitySpanQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<CharacteristicEntitySpanQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, CharacteristicEntitySpanQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(
    db: &mut Self
) -> QueryTableMut<Self, CharacteristicEntitySpanQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <CharacteristicEntitySpanQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<TyQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, TyQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, TyQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <TyQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<SignatureQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, SignatureQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, SignatureQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <SignatureQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<GenericDeclarationsQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, GenericDeclarationsQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(
    db: &mut Self
) -> QueryTableMut<Self, GenericDeclarationsQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <GenericDeclarationsQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<ResolveNameQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, ResolveNameQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, ResolveNameQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <ResolveNameQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<BaseTypeCheckQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, BaseTypeCheckQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, BaseTypeCheckQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <BaseTypeCheckQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl GetQueryTable<FullTypeCheckQuery> for LarkDatabase

fn get_query_table(db: &Self) -> QueryTable<Self, FullTypeCheckQuery>

Create a query table, which has access to the storage for the query and offers methods like get.

fn get_query_table_mut(db: &mut Self) -> QueryTableMut<Self, FullTypeCheckQuery>

Create a mutable query table, which has access to the storage for the query and offers methods like set.

fn descriptor(
    db: &Self,
    key: <FullTypeCheckQuery as Query<Self>>::Key
) -> Self::QueryDescriptor

Create a query descriptor given a key for this query.

impl ParallelDatabase for LarkDatabase

fn snapshot(&self) -> Snapshot<Self>

Creates a second handle to the database that holds the database fixed at a particular revision. So long as this "frozen" handle exists, any attempt to [set] an input will block.

impl PrettyPrintDatabase for LarkDatabase

impl TypeCheckDatabase for LarkDatabase

fn base_type_check(
    &self,
    key: Entity
) -> WithError<Arc<TypeCheckResults<BaseInferred>>>

Compute the "base type information" for a given fn body. This is the type information excluding permissions.

fn full_type_check(
    &self,
    key: Entity
) -> WithError<Arc<TypeCheckResults<FullInferred>>>

Compute the "base type information" for a given fn body. This is the type information excluding permissions.