robur/ocaml-solo5-elftool
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ocaml-solo5-elftool/lib/solo5_elftool.mli

22 lines
759 B
OCaml
Raw Normal View History

Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** An entry in the manifest representing a device. *)
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
type mft_entry =
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
| Dev_block_basic of string
| Dev_net_basic of string
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** The Solo5 manifest *)
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
type mft = {
version : int;
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** [version] is at the moment always 1. *)
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
entries : mft_entry list;
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** [entries] in the manifest. *)
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
}
val pp_mft_entry : Format.formatter -> mft_entry -> unit
val pp_mft : Format.formatter -> mft -> unit
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** Pretty-prints the manifest as JSON in a similar style as the Solo5 command
* line tool {[solo5-elftool query-manifest]}. *)
Use result, improve API * Asserts and cstruct exceptions are removed in favor of result * Parse separately and don't emit `RESERVED_FIRST` mft_entry * Add .mli file exposing types, pretty printers and `query_manifest`
2021-12-13 13:58:44 +00:00
val query_manifest : Owee_buf.t -> (mft, [> `Msg of string ]) result
Remove inline record, documentation The single-field records are unnecessary and a left-over from an earlier iteration of the code.
2021-12-15 15:12:31 +00:00
(** [query_manifest buf] is the solo5 manifest of [buf], or an error message.
* @raise Owee_buf.Invalid_format If [buf] does not contain valid ELF format *)
Copy permalink