package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Library names
Libraries

b0
- B0_build
- B0_cli
  - Arg
- B0_cmdlet
  - Env
  - Map
  - Set
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_dir
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
- B0_file
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Action
  - Map
  - Set
b0.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_cmd
- B0_cmd_cmdlet
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_list
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_root
- B0_cmd_scope
- B0_cmd_unit
- B0_main
b0.b00
- B00
  - Env
  - Memo
  - Store
  - Tool
- B000
  - Exec
  - File_cache
  - Guard
  - Op
    
    Copy
    
    Delete
    
    Map
    
    Mkdir
    
    Notify
    
    Read
    
    Set
    
    Spawn
    
    Wait_files
    
    Write
  - Reviver
  - Trash
- B000_conv
  - Op
b0.b00.kit
- B00_base64
- B00_cli
  - Arg
  - B0_std
  - Exit
  - File_cache
  - Memo
    
    Log
  - Op
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Auth
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
    
    Name
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_jsoo
- B00_lines
- B00_ocaml
  - Archive
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Crunch
  - Lib
    
    Name
    
    Map
    
    Set
    
    Resolver
  - Link
  - Mod
    
    Name
    
    Ref
    
    Map
    
    Set
    
    Src
    
    Deps
  - Ocamlpath
  - Tool
- B00_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
  - Theme
- B00_os
- B00_pager
  - Env
- B00_pdf_viewer
  - Env
- B00_rsync
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_trace
  - Compilation_database
  - Trace_event
- B00_vcs
  - Git
  - Hg
- B00_www_browser
  - Env
b0.kit
- B0_expect
  - Outcome
- B0_jsoo
- B0_kit
  - V000
- B0_ocaml
  - Meta
- B0_ocaml_eco
- B0_opam
  - Cmdlet
  - File
  - Meta
- B0_release
  - Cmdlet
  - Meta
- B0_srcs
b0.std
- B0_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Fut
    
    Syntax
  - Hash
    
    T
    
    Xxh3_128
    
    Xxh3_64
  - List
  - Log
  - Mtime
    
    Span
  - Os
    
    Cmd
    
    Cpu
    
    Time
    
    Dir
    
    Env
    
    Exit
    
    Fd
    
    File
    
    Mtime
    
    Path
  - Result
    
    Syntax
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tty
  - Type
    
    Id

Legend:
Library
Module
Module type
Parameter
Class
Class type

Library information and lookup.

An OCaml library is a directory with interfaces and object files. OCaml libraries are resolved by name using a B00_ocaml.Resolver.

Library names

module Name : sig ... end

Library names.

Libraries

type t

The type for libraries.

val v : 
  name:Name.t ->
  requires:Name.t list ->
  dir:B0_std.Fpath.t ->
  cmis:B0_std.Fpath.t list ->
  cmxs:B0_std.Fpath.t list ->
  cma:B0_std.Fpath.t option ->
  cmxa:B0_std.Fpath.t option ->
  c_archive:B0_std.Fpath.t option ->
  c_stubs:B0_std.Fpath.t list ->
  js_stubs:B0_std.Fpath.t list ->
  t

v ~name ~cmis ~cmxs ~cma ~cmxa is a library named name which requires libraries requires, and library directory dir, has cmis cmi files, cmxs cmx files, cma bytecode archive, cmxa native code archive and it's companion c_archive as well as c_stubs archives. Theoretically all files should be in dir.

val of_dir : 
  B00.Memo.t ->
  clib_ext:B0_std.Fpath.ext ->
  name:Name.t ->
  requires:Name.t list ->
  dir:B0_std.Fpath.t ->
  archive:string option ->
  js_stubs:B0_std.Fpath.t list ->
  (t, string) result B0_std.Fut.t

of_dir m ~clib_ext ~name ~requires ~dir ~archive is a library named name which requires libraries requires, with library directory dir and library archive name archive (without extension and if any) and JavaScript stubs js_stubs. This looks up all files other files in dir and makes them ready in m. It also makes js_stubs files ready. clib_ext is the platform specific extension for C libraries.

Note. If dir doesn't follow the one library per directory convention this over-approximate cmis, cmxs and c_stubs files.

val name : t -> Name.t

name l is the library name of l.

val requires : t -> Name.t list

requires l are the libraries that are required by l.

val dir : t -> B0_std.Fpath.t

dir l is l's library directory.

val cmis : t -> B0_std.Fpath.t list

cmis l is the list of cmis for the library.

val cmxs : t -> B0_std.Fpath.t list

cmxs l is the list of cmxs for the library.

val cma : t -> B0_std.Fpath.t option

cma l is the library's cma file (if any).

val cmxa : t -> B0_std.Fpath.t option

cmxa l is the library's cmxa file (if any).

val c_archive : t -> B0_std.Fpath.t option

c_archive l is the library's cmxa's companion C archive. Must exist if the cmxa exists and, since 4.12 if cmxa is not empty.

val c_stubs : t -> B0_std.Fpath.t list

c_stubs l is the library's C stubs archives (if any).

val js_stubs : t -> B0_std.Fpath.t list

js_stubs l is the library's JavaScript stubs (if any).

module Resolver : sig ... end

Library resolvers.