Curl | Reservoir

leanCurl

leanCurl is a Lean 4 package for the libcurl Easy interface.

Status:

compiles with libcurl 7.68.0,
tested on Ubuntu 20.04 and Windows 11,
only a few Curl options are implemented, see Options.

Installation

Installation steps:

if curl is installed
- leanCurl uses the corresponding libcurl shared library
- otherwise install curl or the libcurl shared library (see curl Download)
execute lake update

Lake configuration arguments:

libcurlSharedLib, path to the libcurl shared library,
libcurlIncludeDir, path to the libcurl include directory.

To complile on macOS, you have to reinstall curl (linking to the pre-installed libcurl library doesn't work)

 brew reinstall curl

Examples

Post Json data:

def main : IO Unit := do
    -- make IO.Ref Stream.Buffer for response data
    let response ← IO.mkRef { : IO.FS.Stream.Buffer}

    -- perfom the network transfer 
    curl_easy_perform_with_options #[       
        CurlOption.URL "https://dummyjson.com/products/add", -- set Url        
        CurlOption.COPYPOSTFIELDS "{\"title\": \"curl\"}", -- set HTTP POST data
        CurlOption.HTTPHEADER #["Content-Type: application/json", "Accept: application/json"], -- set HttpHeader       
        CurlOption.WRITEDATA response, -- response data should be written to this buffer
        CurlOption.WRITEFUNCTION Curl.writeBytes
    ]

    -- get Stream.Buffer of IO.Ref 
    let bytes ← response.get
    IO.println s!"response: {String.fromUTF8! bytes.data}"

The corresponding curl command is

curl -d "{\"title\": \"curl\"}" https://dummyjson.com/products/add

The --libcurl option displays the correspondence.

Example projects (see build-examples.sh):