Expand description
Project Model for tinymist
Re-exports§
pub use tinymist_task as task;
pub use world::*;
Modules§
Structs§
- Apply
Project Task - A project task application specifier. This is used for specifying tasks to run in a project. When the language service notifies an update event of the project, it will check whether any associated tasks need to be run.
- Compile
Font Args - The font arguments for the world to specify the way to search for fonts.
- Compile
Package Args - The package arguments for the world to specify where packages are stored in the system.
- Compile
Report - The compilation status of a project.
- Compile
Report Msg - A message of the compilation status.
- Compile
Server Opts - The compiler server options.
- Compile
Signal - A signal that possibly triggers a compile (export).
- Compile
Snapshot - A snapshot of the project and compilation state.
- Compile
Status Result - The compilation status result of a project.
- Compiled
Artifact - A compiled artifact.
- DocConfigure
Args - Configure project’s priorities.
- DocId
Args - Specify the id of a document.
- DocNew
Args - Declare a document (project’s input).
- Document
Query - The computation for document query.
- DynAccess
Model - Access model for LSP universe and worlds.
- Entry
Resolver - Entry resolver
- Export
Html Task - An export html task specifier.
- Export
Markdown Task - An export markdown task specifier.
- Export
PdfTask - An export pdf task specifier.
- Export
PngTask - An export png task specifier.
- Export
SvgTask - An export svg task specifier.
- Export
Task - An export task specifier.
- Export
TeXTask - An export TeX task specifier.
- Export
Text Task - An export text task specifier.
- Export
Timings - The computation to check if the export is needed.
- Html
Export - The computation for html export.
- Html
Flag - The flag indicating that the html export is needed.
- Id
- A project ID.
- Lock
File - A lock file storing project information.
- Lock
File Update - A lock file update.
- LspCompiler
Feat - Compiler feature for LSP universe and worlds without typst.ts to implement
more for tinymist. type trait of
CompilerUniverse
. - LspUniverse
Builder - Builder for LSP universe.
- Notify
Actor - The actor that watches files. It is used to watch files and send events to the consumers
- Pages
- Implements parsing of page ranges (
1-3
,4
,5-
,-2
), used by theCompileCommand.pages
argument, through theFromStr
trait instead of a value parser, in order to generate better errors. - Path
Pattern - The path pattern that could be substituted.
- PdfExport
- The computation for pdf export.
- PdfExport
Args - Specify the PDF export related arguments.
- PngExport
- The computation for png export.
- PngExport
Args - Specify the PNG export related arguments.
- PngFlag
- The flag indicating that the png export is needed.
- Preview
Task - A preview task specifier.
- Project
Compiler - The synchronous compiler that runs on one project or multiple projects.
- Project
Input - A project input specifier.
- Project
InsId - Project instance id. This is slightly different from the project ids that persist in disk.
- Project
InsState - A project instance state.
- Project
Material - A project route specifier.
- Project
Path Material - A project route specifier.
- Project
Route - A project route specifier.
- Query
Task - An export query task specifier.
- Resource
Path - A resource path.
- Scalar
- A scalar that is not NaN.
- SvgExport
- The computation for svg export.
- SvgFlag
- The flag indicating that the svg export is needed.
- Task
Compile Args - Declare an compile task.
- Text
Export - The computation for text export.
Enums§
- Compile
Status Enum - The compilation status of a project.
- DocCommands
- Project document commands.
- Export
Target - Configure the current export target.
- Export
Transform - A project export transform specifier.
- Interrupt
- An interrupt to the compiler.
- Lock
File Compat - A lock file compatibility wrapper.
- Output
Format - Configure the format of the output file.
- Page
Selection - The legacy page selection specifier.
- PdfStandard
- A PDF standard that Typst can enforce conformance with.
- Project
Resolution Kind - The kind of project resolution.
- Project
Task - A project task specifier. This structure specifies the arguments for a task.
- Task
When - Configure when to run a task.
- Typst
PdfStandard - A PDF standard that Typst can enforce conformance with.
Constants§
- FILE_
MISSING_ ERROR - The file missing error constant.
- LOCK_
FILENAME - The default name of the lock file used by tinymist.
- LOCK_
VERSION - The currently using lock file version.
- PROJECT_
ROUTE_ USER_ ACTION_ PRIORITY - The default project route priority assigned to user actions.
Traits§
- Compile
Handler - A project compiler handler.
- LspAccess
Model - Access model for LSP universe and worlds.
- World
Provider - World provider for LSP universe and worlds.
Functions§
- get_
page_ selection - Gets legacy page selection
- Export a document into a PDF file.
- spawn_
cpu - Spawns a CPU thread to run a computing-heavy task.
- update_
lock - Make a new project lock updater.
- watch_
deps - Watches on a set of files.
Type Aliases§
- CtxPath
- The path context.
- Immut
Dict - Immutable prehashed reference to dictionary.
- LspCompile
Snapshot - LSP compile snapshot.
- LspCompiled
Artifact - LSP compiled artifact.
- LspCompute
Graph - LSP compute graph.
- LspInterrupt
- LSP interrupt.
- LspUniverse
- LSP universe that spawns LSP worlds.
- LspWorld
- LSP world that holds compilation resources