package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

HTTP methods and headers
HTTP requests
HTTP responses
Performing requests

package b0

b0.b00
- B00
  - Env
  - Exec
  - File_cache
    
    Stats
  - Guard
  - Memo
    
    Fut
  - Op
    
    Map
    
    Mkdir
    
    Read
    
    Set
    
    Spawn
    
    Write
  - Op_cache
  - Tool
b0.care
- B0_github
  - Issue
  - Pages
  - Release
  - Repo
- B0_machine
- B0_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
- B0_trace
  - Compilation_database
  - Trace_event
- B0_ui
  - Browser
  - Cli
    
    Arg
    
    B0_std
  - Editor
  - Memo
  - Pager
- B0_vcs
  - Git
- B0_web
  - Htmlg
    
    Att
    
    El
  - Http
  - Json
  - Jsong
  - Jsonq
b0.std
- B0_std
  - Char
    
    Ascii
  - Cmd
  - Conv
    
    Bin
    
    Txt
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
  - Result
  - String
    
    Ascii
    
    Map
    
    Set
  - Time
    
    Span
  - Tty

Legend:
Library
Module
Module type
Parameter
Class
Class type

HTTP requests.

HTTP requests via curl.

HTTP methods and headers

type meth = [

| `CONNECT
| `DELETE
| `GET
| `HEAD
| `OPTIONS
| `Other of string
| `PATCH
| `POST
| `PUT
| `TRACE

]

The type for HTTP methods.

val meth_to_string : meth -> string

meth_to_string m is a string representation of m.

type headers = (string * string) list

The type for HTTP headers.

HTTP requests

type req

The type for HTTP requests.

val req : ?headers:headers -> ?body:string -> uri:string -> meth -> req

req uri m ~headers ~body is a request on uri with method m, headers headers (defaults to []) and body body (defaults to "").

val req_uri : req -> string

req_uri r is r's request URI.

val req_meth : req -> meth

req_meth r is r's HTTP method.

val req_headers : req -> headers

req_headers r is r's headers.

val req_body : req -> string

req_body r is r's body.

HTTP responses

type resp

The type for HTTP responses.

val resp_headers : resp -> headers

resp_headers r are the HTTP response headers.

val resp_status : resp -> int

resp_status r is the HTTP response status.

val resp_body : resp -> string

resp_body r is the HTTP response body.

Performing requests

type t

The type for HTTP requestors.

val curl : 
  ?docs:string ->
  ?env:Cmdliner.Arg.env ->
  unit ->
  B0_std.Cmd.t Cmdliner.Term.t

curl is a cli interface for specifying the curl command line tool.

val find_curl : 
  ?search:B0_std.Fpath.t list ->
  curl:B0_std.Cmd.t ->
  unit ->
  (t, string) result

val perform : ?follow:bool -> t -> req -> (resp, string) result

perform curl r performs request r via curl which is looked up in the PATH or in the environment variable B0_CURL. If follow is true (default) HTTP redirects for GET and HEAD requests that return 301, 302, 303, 305 or 307 are automatically followed.