CompilationJob

Struct in Yarn.Compiler

Inherits from System.ValueType

Summary

An object that contains Yarn source code to compile, and instructions on how to compile it.

public struct CompilationJob

Remarks

Instances of this struct are used with Compile(CompilationJob) to produce CompilationResult objects.

Classes

Name	Description
File	Represents the contents of a file to compile.

Enums

Name	Description
Type	The type of compilation that the compiler will do.

Fields

Name	Description
CompilationType	The type of compilation to perform.
Declarations	The declarations for variables and functions.
Inputs
Library	The Library that contains declarations for functions.

Methods

Name	Description
CreateFromFiles(IEnumerable,Library?)	Creates a new CompilationJob using the contents of a collection of files.
CreateFromFiles(string[])	Creates a new CompilationJob using the contents of a collection of files.
CreateFromInputs(IEnumerable,Library?,int)	Creates a new CompilationJob using the contents of a collection of source inputs.
CreateFromString(string,string,Library?,int)	Creates a new CompilationJob using the contents of a string.

Properties

Name	Description
CancellationToken	A cancellation token that can be used to signal that the compilation should be cancelled.
Files	The File structs that represent the content to parse..
LanguageVersion	Gets or sets the version of the Yarn language.
TypeDeclarations	The collection of type declarations that should be imported and made available to the compiler, prior to compilation.
VariableDeclarations	The declarations for variables.