Documentation

Lake.Config.OutFormat

inductive Lake.OutFormat :

Target output formats supported by the Lake CLI (e.g., lake query).

  • text : OutFormat

    Format target output as text.

  • json : OutFormat

    Format target output as JSON.

Instances For
    @[deprecated Lake.QueryText (since := "2025-07-25")]
    class Lake.ToText (α : Type u) :
    Instances
      @[instance 0]
      instance Lake.instToTextOfToString {α : Type u_1} [ToString α] :
      Equations
        @[inline]
        def Lake.listToLines {α : Type u_1} (as : List α) (f : αString) :
        Equations
          Instances For
            @[inline]
            def Lake.arrayToLines {α : Type u_1} (as : Array α) (f : αString) :
            Equations
              Instances For
                instance Lake.instToTextList {α : Type u_1} [ToText α] :
                Equations
                  instance Lake.instToTextArray {α : Type u_1} [ToText α] :
                  Equations
                    class Lake.QueryText (α : Type u) :

                    Class used to format target output as text for lake query.

                    • queryText : αString

                      Format target output as text (e.g., for lake query).

                    Instances
                      @[instance 0]
                      instance Lake.instQueryText {α : Type u_1} :
                      Equations
                        @[instance 100]
                        instance Lake.instQueryTextOfToText {α : Type u_1} [ToText α] :
                        Equations
                          instance Lake.instQueryTextList {α : Type u_1} [QueryText α] :
                          Equations
                            instance Lake.instQueryTextArray {α : Type u_1} [QueryText α] :
                            Equations
                              class Lake.QueryJson (α : Type u) :

                              Class used to format target output as JSON for lake query -J.

                              • queryJson : αLean.Json

                                Format target output as JSON (e.g., for lake query -J).

                              Instances
                                @[instance 0]
                                instance Lake.instQueryJson {α : Type u_1} :
                                Equations
                                  @[instance 100]
                                  Equations
                                    instance Lake.instQueryJsonList {α : Type u_1} [QueryJson α] :
                                    Equations
                                      instance Lake.instQueryJsonArray {α : Type u_1} [QueryJson α] :
                                      Equations
                                        class Lake.FormatQuery (α : Type u) extends Lake.QueryText α, Lake.QueryJson α :

                                        Class used to format target output for lake query.

                                        Instances
                                          def Lake.nullFormat {α : Sort u_1} (fmt : OutFormat) :
                                          αString

                                          Format function that produces "null" output.

                                          Equations
                                            Instances For
                                              @[specialize #[]]
                                              def Lake.formatQuery {α : Type u_1} [FormatQuery α] (fmt : OutFormat) (a : α) :

                                              Format function that uses QueryText and QueryJson to produce output.

                                              Equations
                                                Instances For
                                                  def Lake.ppImport (imp : Lean.Import) (isModule : Bool) (init : String := "") :
                                                  Equations
                                                    Instances For
                                                      Equations
                                                        Instances For