Crate tinymist_project

Project Model for tinymist

Re-exports

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

Modules

• compute
• 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 compiler.
• CompilePackageArgs
  Arguments related to where packages are stored in the system.
• CompileReasons
  An accumulated compile reason stored in the project state.
• CompileReport
  The compilation status of a project.
• CompileReportMsg
• CompileServerOpts
  The compiler server options.
• 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
  The id of a document.
• DocNewArgs
  Declare a document (project’s input).
• DocumentQuery
• 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.
• ExportSignal
  A signal that possibly triggers an export.
• ExportSvgTask
  An export svg task specifier.
• ExportTask
  An export task specifier.
• ExportTextTask
  An export text task specifier.
• ExportTimings
• HtmlExport
• HtmlFlag
• Id
  A project ID.
• LockFile
  A lock file storing project information.
• LockFileUpdate
• 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
• PdfExportArgs
  Declare arguments for exporting a document to PDF.
• PngExport
• PngExportArgs
  Declare arguments for exporting a document to PNG.
• PngFlag
• 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
• SvgFlag
• TaskCompileArgs
  Declare an compile task.
• TextExport

Enums

• CompileStatusEnum
  The compilation status of a project.
• DocCommands
  Project document commands.
• ExportTarget
  Specifies the current export target.
• ExportTransform
  A project export transform specifier.
• Interrupt
  An interrupt to the compiler.
• LockFileCompat
  A lock file compatibility wrapper.
• OutputFormat
  Which format to use for the generated 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
  When to export an output file.
• TypstPdfStandard
  A PDF standard that Typst can enforce conformance with.

Constants

• LOCK_FILENAME
• 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.
• WorldProvider
  World provider for LSP universe and worlds.

Functions

• get_page_selection
  Gets legacy page selection
• pdf
  Export a document into a PDF file.
• update_lock
  Make a new project lock updater.
• watch_deps
  Watches on a set of files.

Type Aliases

• 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