Crate tinymist_project

Source
Expand description

Project Model for tinymist

Re-exports§

pub use tinymist_task as task;
pub use world::*;

Modules§

compute
The computations for the tasks.
world
World implementation of typst for tinymist.

Structs§

ApplyProjectTask
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.
CompileFontArgs
The font arguments for the world to specify the way to search for fonts.
CompilePackageArgs
The package arguments for the world to specify where packages are stored in the system.
CompileReport
The compilation status of a project.
CompileReportMsg
A message of the compilation status.
CompileServerOpts
The compiler server options.
CompileSignal
A signal that possibly triggers a compile (export).
CompileSnapshot
A snapshot of the project and compilation state.
CompileStatusResult
The compilation status result of a project.
CompiledArtifact
A compiled artifact.
DocConfigureArgs
Configure project’s priorities.
DocIdArgs
Specify the id of a document.
DocNewArgs
Declare a document (project’s input).
DocumentQuery
The computation for document query.
DynAccessModel
Access model for LSP universe and worlds.
EntryResolver
Entry resolver
ExportHtmlTask
An export html task specifier.
ExportMarkdownTask
An export markdown task specifier.
ExportPdfTask
An export pdf task specifier.
ExportPngTask
An export png task specifier.
ExportSvgTask
An export svg task specifier.
ExportTask
An export task specifier.
ExportTeXTask
An export TeX task specifier.
ExportTextTask
An export text task specifier.
ExportTimings
The computation to check if the export is needed.
HtmlExport
The computation for html export.
HtmlFlag
The flag indicating that the html export is needed.
Id
A project ID.
LockFile
A lock file storing project information.
LockFileUpdate
A lock file update.
LspCompilerFeat
Compiler feature for LSP universe and worlds without typst.ts to implement more for tinymist. type trait of CompilerUniverse.
LspUniverseBuilder
Builder for LSP universe.
NotifyActor
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 the CompileCommand.pages argument, through the FromStr trait instead of a value parser, in order to generate better errors.
PathPattern
The path pattern that could be substituted.
PdfExport
The computation for pdf export.
PdfExportArgs
Specify the PDF export related arguments.
PngExport
The computation for png export.
PngExportArgs
Specify the PNG export related arguments.
PngFlag
The flag indicating that the png export is needed.
PreviewTask
A preview task specifier.
ProjectCompiler
The synchronous compiler that runs on one project or multiple projects.
ProjectInput
A project input specifier.
ProjectInsId
Project instance id. This is slightly different from the project ids that persist in disk.
ProjectInsState
A project instance state.
ProjectMaterial
A project route specifier.
ProjectPathMaterial
A project route specifier.
ProjectRoute
A project route specifier.
QueryTask
An export query task specifier.
ResourcePath
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.
TaskCompileArgs
Declare an compile task.
TextExport
The computation for text export.

Enums§

CompileStatusEnum
The compilation status of a project.
DocCommands
Project document commands.
ExportTarget
Configure the current export target.
ExportTransform
A project export transform specifier.
Interrupt
An interrupt to the compiler.
LockFileCompat
A lock file compatibility wrapper.
OutputFormat
Configure the format of the output file.
PageSelection
The legacy page selection specifier.
PdfStandard
A PDF standard that Typst can enforce conformance with.
ProjectResolutionKind
The kind of project resolution.
ProjectTask
A project task specifier. This structure specifies the arguments for a task.
TaskWhen
Configure when to run a task.
TypstPdfStandard
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§

CompileHandler
A project compiler handler.
LspAccessModel
Access model for LSP universe and worlds.
WorldProvider
World provider for LSP universe and worlds.

Functions§

get_page_selection
Gets legacy page selection
pdf
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.
ImmutDict
Immutable prehashed reference to dictionary.
LspCompileSnapshot
LSP compile snapshot.
LspCompiledArtifact
LSP compiled artifact.
LspComputeGraph
LSP compute graph.
LspInterrupt
LSP interrupt.
LspUniverse
LSP universe that spawns LSP worlds.
LspWorld
LSP world that holds compilation resources