Documentation

Lean.Setup

structure Lean.Import :
  • 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.

  • isMeta : Bool

    Whether to import IR for all definitions (transitively) reachable.

Instances For
    Equations
      Instances For
        Equations
          Instances For
            Equations
              Instances For
                Equations
                  Instances For

                    Abstract structure of a module's header.

                    • imports : Array Import

                      The module's direct imports (i.e., those listed in the header).

                    • isModule : Bool

                      Whether the module is participating in the module system.

                    Instances For
                      Equations
                        Instances For

                          Module data files used for an import statement. This structure is designed for efficient JSON serialization.

                          Instances For
                            Equations
                              Instances For
                                Equations
                                  Instances For

                                    Files containing data for a single module.

                                    Instances For
                                      @[reducible, inline]

                                      The type of module package identifiers.

                                      This is a String that is used to disambiguate native symbol prefixes between different packages (and different versions of the same package).

                                      Equations
                                        Instances For

                                          A module's setup information as described by a JSON file.

                                          • name : Name

                                            The name of the module.

                                          • package? : Option PkgId

                                            The package to which the module belongs (if any).

                                          • isModule : Bool

                                            Whether the module, by default, participates in the module system. Even if false, a module can still choose to participate by using module in its header.

                                          • imports? : Option (Array Import)

                                            The module's direct imports. If none, uses the imports from the module header.

                                          • Pre-resolved artifacts of transitively imported modules.

                                          • Dynamic libraries to load with the module.

                                          • Plugins to initialize with the module.

                                          • options : LeanOptions

                                            Additional options for the module.

                                          Instances For
                                            Equations
                                              Instances For

                                                Load a ModuleSetup from a JSON file.

                                                Equations
                                                  Instances For