Module Setup Information

Data types used by Lean module headers and the --setup CLI.

structure Lean.Import : Type

• module : Name
• importAll : Bool

  import all; whether to import and expose all data saved by the module.

• isExported : Bool

  Whether to activate this import when the current module itself is imported.

instance Lean.instReprImport : Repr Import

Equations

• Lean.instReprImport = { reprPrec := Lean.reprImport✝ }

instance Lean.instInhabitedImport : Inhabited Import

Equations

• Lean.instInhabitedImport = { default := { module := default, importAll := default, isExported := default } }

instance Lean.instToJsonImport : ToJson Import

Equations

• Lean.instToJsonImport = { toJson := Lean.toJsonImport✝ }

instance Lean.instFromJsonImport : FromJson Import

Equations

• Lean.instFromJsonImport = { fromJson? := Lean.fromJsonImport✝ }

instance Lean.instCoeNameImport : Coe Name Import

Equations

• Lean.instCoeNameImport = { coe := fun (x : Lean.Name) => { module := x } }

instance Lean.instToStringImport : ToString Import

Equations

• Lean.instToStringImport = { toString := fun (imp : Lean.Import) => toString imp.module }

structure Lean.ModuleArtifacts : Type

Files containing data for a single module.

• lean? : Option System.FilePath
• olean? : Option System.FilePath
• oleanServer? : Option System.FilePath
• oleanPrivate? : Option System.FilePath
• ilean? : Option System.FilePath

instance Lean.instReprModuleArtifacts : Repr ModuleArtifacts

Equations

• Lean.instReprModuleArtifacts = { reprPrec := Lean.reprModuleArtifacts✝ }

instance Lean.instInhabitedModuleArtifacts : Inhabited ModuleArtifacts

Equations

• Lean.instInhabitedModuleArtifacts = { default := { lean? := default, olean? := default, oleanServer? := default, oleanPrivate? := default, ilean? := default } }

instance Lean.instToJsonModuleArtifacts : ToJson ModuleArtifacts

Equations

• Lean.instToJsonModuleArtifacts = { toJson := Lean.toJsonModuleArtifacts✝ }

instance Lean.instFromJsonModuleArtifacts : FromJson ModuleArtifacts

Equations

• Lean.instFromJsonModuleArtifacts = { fromJson? := Lean.fromJsonModuleArtifacts✝ }

structure Lean.ModuleSetup : Type

A module's setup information as described by a JSON file. Supersedes the module's header when the --setup CLI option is used.

• name : Name

  Name of the module.

• isModule : Bool

  Whether the module is participating in the module system.

• imports : Array Import
• modules : NameMap ModuleArtifacts

  Pre-resolved artifacts of related modules (e.g., this module's transitive imports).

• dynlibs : Array System.FilePath

  Dynamic libraries to load with the module.

• plugins : Array System.FilePath

  Plugins to initialize with the module.

• options : LeanOptions

  Additional options for the module.

instance Lean.instReprModuleSetup : Repr ModuleSetup

Equations

• Lean.instReprModuleSetup = { reprPrec := Lean.reprModuleSetup✝ }

instance Lean.instInhabitedModuleSetup : Inhabited ModuleSetup

Equations

• One or more equations did not get rendered due to their size.

instance Lean.instToJsonModuleSetup : ToJson ModuleSetup

Equations

• Lean.instToJsonModuleSetup = { toJson := Lean.toJsonModuleSetup✝ }

instance Lean.instFromJsonModuleSetup : FromJson ModuleSetup

Equations

• Lean.instFromJsonModuleSetup = { fromJson? := Lean.fromJsonModuleSetup✝ }

def Lean.ModuleSetup.load (path : System.FilePath) : IO ModuleSetup

Load a ModuleSetup from a JSON file.

Equations

• One or more equations did not get rendered due to their size.