package binsec

  1. Overview
  2. Docs
package binsec
Legend:
Library
Module
Module type
Parameter
Class
Class type

Functors for command-line parameters declarations

module type GENERIC = sig ... end
module type CHECKABLE = sig ... end
module type GENERIC_OPT = sig ... end
Module types for option builders
module type BOOLEAN = GENERIC with type t = bool
module type INTEGER = GENERIC with type t = int
module type INTEGER_SET = CHECKABLE with type t = Basic_types.Int.Set.t
module type INTEGER_LIST = CHECKABLE with type t = int list
module type INTEGER_OPT = GENERIC_OPT with type t = int
module type FLOAT = GENERIC with type t = float
module type FLOAT_SET = CHECKABLE with type t = Basic_types.Float.Set.t
module type FLOAT_LIST = CHECKABLE with type t = float list
module type FLOAT_OPT = GENERIC_OPT with type t = float
module type STRING = GENERIC with type t = string
module type STRING_OPT = GENERIC_OPT with type t = string
module type STRING_LIST = CHECKABLE with type t = string list

Builder functors for command-line parameters

module type DECL = sig ... end
module type CLI_DECL = sig ... end
module type DEFAULTED_CLI_DECL = sig ... end
module type DETAILED_CLI_DECL = sig ... end
module type S = sig ... end

Functor signature

module type Cli_sig = sig ... end

Functor

module Make (D : DECL) : sig ... end

Call Cli.Make to create a kind of command line namespace

module Options (D : DECL) : Cli_sig

Call Cli.Options instead if you just want to have dedicated options to a ** set of functionalities. ** ** The difference with Cli.Make is the absence of a dedicated command line ** switch for this set of options. ** ** For example Cli.Make(struct let name = "foo" ... end) will add a '-foo' ** global switch to the command line whereas Cli.Options(struct let name = ** "foo" ... end) will not. ** ** Also, using Cli.Options entails that there should not be any associated ** functions to be automatically run at startup (i.e., no Cli.Boot.enlist ** call from inside the functionality kernel associated with this set of ** command-line switches).

Boot

This module collects the functions to be executed at startup time.

module Boot : sig ... end
val parse : unit -> string list

parse () parses options from the command line.

val parse_configuration_file : filename:string -> string list

parse () parses options from configuration file filename.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct