package wire

  1. Overview
  2. Docs
Binary wire format DSL with EverParse 3D output

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (3)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Maintainers

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>

Sources

wire-1.0.0.tbz
sha256=323f48e6cb897fe48aac558b09bb25134d3b19fec37b20d7930eec15f387c238
sha512=00c77f8672396ab15d993602db9bab95d2478ace1f569606f0140ed25d7ff852525e53436d95e5061442a6ea8b5650549239c68ef861b4b921b4a53faac97eb7

doc/wire/Wire/Everparse/Raw/index.html

Module Everparse.RawSource

Escape hatch for manual 3D authoring.

These constructors exist for EverParse features that currently have no codec-level equivalent, plus the struct-level projection knobs. Most users should stay on the Field/Codec path and use project.

Sourcetype nonrec struct_ = struct_
Sourcetype field = Field.packed
Sourcetype nonrec decl = decl
Sourcetype nonrec decl_case = decl_case
Sourcetype nonrec module_ = module_
Sourcetype nonrec t = t
Sourceval typedef : ?entrypoint:bool -> ?export:bool -> ?output:bool -> ?extern_:bool -> ?doc:string -> struct_ -> decl

Top-level typedef declaration.

Sourceval define : string -> int -> decl

Top-level integer definition.

Sourceval extern_fn : string -> param list -> 'a typ -> decl

External function declaration used by 3D actions.

Sourceval extern_probe : ?init:bool -> string -> decl

External probe declaration.

Sourceval enum_decl : string -> (string * int) list -> 'a typ -> decl

Top-level enum declaration.

Sourceval decl_case : int -> 'a typ -> decl_case

One tagged case in a top-level casetype declaration.

Sourceval decl_default : 'a typ -> decl_case

Default case in a top-level casetype declaration.

Sourceval casetype_decl : string -> param list -> 'a typ -> decl_case list -> decl

Top-level casetype declaration.

Sourceval module_ : ?doc:string -> decl list -> module_

Builds a 3D module from declarations.

Sourceval to_3d : ?enum_as_type:bool -> module_ -> string

Renders a 3D module to text. With ~enum_as_type:true an enum field renders as its named 3D enum type rather than the base type plus a membership refinement.

Sourceval to_3d_file : ?enum_as_type:bool -> string -> module_ -> unit

Writes a rendered 3D module to a file. See to_3d for enum_as_type.

Sourceval struct_of_codec : 'r Codec.t -> struct_

Lower a codec to its 3D struct, the intermediate the stubs and benchmark codegen operate on.

Sourceval project_struct : ?mode:mode -> struct_ -> t

project_struct ?mode s is project on an already-lowered struct.

Sourceval field : string -> ?constraint_:bool expr -> ?action:Action.t -> 'a typ -> field

Named field. Returns a packed Field.t.

Sourceval anon_field : 'a typ -> field

Anonymous field in a 3D struct.

Sourceval field_ref : field -> int expr

field_ref f returns the expression referencing field f by name. The field must have been created with field (not anon_field).

Sourceval struct_ : string -> field list -> struct_

Non-parameterised 3D struct.

Sourceval struct_name : struct_ -> string

Name of a struct declaration.

Sourceval field_names : struct_ -> string list

Named field names in declaration order.

Sourcetype ocaml_kind =
  1. | Int
  2. | Int64
  3. | Float32
  4. | Float64
  5. | Bool
  6. | String
  7. | Unit
    (*

    The OCaml representation kind of a field (for FFI stub generation).

    *)
Sourceval field_kinds : struct_ -> (string * ocaml_kind) list

Named field names with their OCaml type kind.

Sourceval struct_project : struct_ -> name:string -> keep:Field.packed list -> struct_

struct_project s ~name ~keep returns a copy of s renamed to name keeping only the fields in keep. All others become anonymous.

Sourceval struct_params : struct_ -> param list

Formal parameters of a struct (empty for non-parameterised structs).

Sourceval input_param_names : struct_ -> string list

Names of the input (non-mutable) parameters, in declaration order, which is the order the generated validator and its wrapper take them.

Sourceval input_param_c_types : struct_ -> string list

C type of each input (non-mutable) parameter, in declaration order, e.g. ["uint8_t"; "uint16_t"]. Matches the widths the generated validator wrapper takes, so a caller can build the wrapper call without reading the generated header.

Sourceval struct_typ : struct_ -> unit typ

View a 3D struct as a wire description.

Sourceval param : string -> 'a typ -> param

Immutable parameter declaration.

Sourceval mutable_param : string -> 'a typ -> param

Mutable parameter declaration.

Sourceval param_struct : string -> param list -> ?where:bool expr -> field list -> struct_

Parameterised 3D struct.

Sourceval apply : 'a typ -> int expr list -> 'a typ

Apply a parameterised description to integer arguments.

Sourceval type_ref : string -> 'a typ

Unqualified type reference.

Sourceval qualified_ref : string -> string -> 'a typ

Qualified type reference.

Sourceval pp_typ : Format.formatter -> 'a typ -> unit

Pretty-printer for 3D-facing type syntax.

Sourceval pp_module : Format.formatter -> module_ -> unit

Pretty-printer for 3D modules.

Sourceval struct_size : struct_ -> int option

Fixed wire size of a struct, if known statically.

Sourceval of_module : name:string -> module_:module_ -> wire_size:int -> t

Wraps an existing 3D module as a schema.