Package Registries

This module contains definitions for fetching Lake package information from a online registry (e.g., Reservoir).

inductive Lake.RegistrySrc : Type

Package source information from a Lake registry (e.g., Reservoir). Only contains the subset of fields useful to Lake.

• git (data : JsonObject) (url : String) (githubUrl? defaultBranch? : Option String) (subDir? : Option System.FilePath) : RegistrySrc
• other (data : JsonObject) : RegistrySrc

instance Lake.instInhabitedRegistrySrc : Inhabited RegistrySrc

def Lake.RegistrySrc.isGit (src : RegistrySrc) : Bool

def Lake.RegistrySrc.data (src : RegistrySrc) : JsonObject

def Lake.RegistrySrc.toJson (src : RegistrySrc) : Lean.Json

instance Lake.RegistrySrc.instToJson : Lean.ToJson RegistrySrc

def Lake.RegistrySrc.fromJson? (val : Lean.Json) : Except String RegistrySrc

instance Lake.RegistrySrc.instFromJson : Lean.FromJson RegistrySrc

structure Lake.RegistryPkg : Type

Package metadata from a Lake registry (e.g., Reservoir). Only contains the subset of fields useful to Lake.

• name : String
• fullName : String
• sources : Array RegistrySrc
• data : Lean.Json

instance Lake.instInhabitedRegistryPkg : Inhabited RegistryPkg

def Lake.RegistryPkg.gitSrc? (pkg : RegistryPkg) : Option RegistrySrc

def Lake.RegistryPkg.toJson (src : RegistryPkg) : Lean.Json

instance Lake.RegistryPkg.instToJson : Lean.ToJson RegistryPkg

def Lake.RegistryPkg.fromJson? (val : Lean.Json) : Except String RegistryPkg

instance Lake.RegistryPkg.instFromJson : Lean.FromJson RegistryPkg

def Lake.hexEncodeByte (b : UInt8) : Char

def Lake.uriEscapeByte (b : UInt8) (s : String := "") : String

Encode a byte as a URI escape code (e.g., %20).

@[specialize #[]]

def Lake.foldlUtf8M {m : Type u_1 → Type u_2} {σ : Type u_1} [Monad m] (c : Char) (f : σ → UInt8 → m σ) (init : σ) : m σ

Folds a monadic function over the UTF-8 bytes of Char from most significant to least significant.

@[reducible, inline]

abbrev Lake.foldlUtf8 {σ : Type u_1} (c : Char) (f : σ → UInt8 → σ) (init : σ) : σ

def Lake.uriEscapeChar (c : Char) (s : String := "") : String

Encode a character as a sequence of URI escape codes representing its UTF8 encoding.

def Lake.isUriUnreservedMark (c : Char) : Bool

A URI unreserved mark as specified in RFC2396.

def Lake.uriEncodeChar (c : Char) (s : String := "") : String

Encodes anything but a URI unreserved character as a URI escape sequences.

def Lake.uriEncode (s : String) : String

Encodes a string as an ASCII URI component, escaping special characters (and unicode).

def Lake.getUrl (url : String) (headers : Array String := #[]) : LogIO String

Perform a HTTP GET request of a URL (using curl) and return the body.

inductive Lake.ReservoirResp (α : Type u) : Type u

A Reservoir API response object.

• data {α : Type u} (a : α) : ReservoirResp α
• error {α : Type u} (status : Nat) (message : String) : ReservoirResp α

def Lake.ReservoirResp.fromJson? {α : Type} [Lean.FromJson α] (val : Lean.Json) : Except String (ReservoirResp α)

instance Lake.instFromJsonReservoirResp {α : Type} [Lean.FromJson α] : Lean.FromJson (ReservoirResp α)

def Lake.Reservoir.pkgApiUrl (lakeEnv : Env) (owner pkg : String) : String

def Lake.Reservoir.lakeHeaders : Array String

def Lake.Reservoir.fetchPkg? (lakeEnv : Env) (owner pkg : String) : LogIO (Option RegistryPkg)