Struct ApplyProjectTask

pub struct ApplyProjectTask {
    pub id: Id,
    pub document: Id,
    pub task: ProjectTask,
}

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.

Each task can have different timing and conditions for running. See TaskWhen for more information.

The available task types listed in the ProjectTask only represent the direct formats supported by the typst compiler. More task types can be customized by the ExportTransform.

Examples

Export a JSON file with the pdfpc notes of the document:

tinymist project query main.typ --format json --selector "<pdfpc-notes>" --field value --one

Export a PDF file and then runs a ghostscript command to compress it:

tinymist project compile main.typ --pipe 'import "@local/postprocess:0.0.1": ghostscript; ghostscript(output.path)'

Fields

id: Id

The task’s ID.

document: Id

The document’s ID.

task: ProjectTask

The task to run.

Implementations

impl ApplyProjectTask

pub fn doc_id(&self) -> &Id

Returns the document’s ID.

pub fn id(&self) -> &Id

Returns the task’s ID.

Trait Implementations

impl Clone for ApplyProjectTask

fn clone(&self) -> ApplyProjectTask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApplyProjectTask

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApplyProjectTask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for ApplyProjectTask

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 ApplyProjectTask

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ApplyProjectTask

impl StructuralPartialEq for ApplyProjectTask