Module `Std.Size`

Type safe operand and register sizes.

type all = [

| `r8
| `r16
| `r32
| `r64
| `r128
| `r256

]

Defines possible sizes for operations operands

val r8 : all

val r16 : all

val r32 : all

val r64 : all

val r128 : all

val r256 : all

val is_r8 : all -> bool

val is_r16 : all -> bool

val is_r32 : all -> bool

val is_r64 : all -> bool

val is_r128 : all -> bool

val is_r256 : all -> bool

val r8_val : all -> unit option

val r16_val : all -> unit option

val r32_val : all -> unit option

val r64_val : all -> unit option

val r128_val : all -> unit option

val r256_val : all -> unit option

module Variants_of_all : sig ... end

type 'a p = 'a constraint 'a = [< all ]

val bin_shape_p : Core_kernel.Bin_prot.Shape.t -> Core_kernel.Bin_prot.Shape.t

val bin_size_p : 
  'a Core_kernel.Bin_prot.Size.sizer ->
  'a p Core_kernel.Bin_prot.Size.sizer

val bin_write_p : 
  'a Core_kernel.Bin_prot.Write.writer ->
  'a p Core_kernel.Bin_prot.Write.writer

val bin_writer_p : 
  'a Core_kernel.Bin_prot.Type_class.writer ->
  'a p Core_kernel.Bin_prot.Type_class.writer

val bin_read_p : 
  'a Core_kernel.Bin_prot.Read.reader ->
  'a p Core_kernel.Bin_prot.Read.reader

val __bin_read_p__ : 
  'a Core_kernel.Bin_prot.Read.reader ->
  (int -> 'a p) Core_kernel.Bin_prot.Read.reader

val bin_reader_p : 
  'a Core_kernel.Bin_prot.Type_class.reader ->
  'a p Core_kernel.Bin_prot.Type_class.reader

val bin_p : 
  'a Core_kernel.Bin_prot.Type_class.t ->
  'a p Core_kernel.Bin_prot.Type_class.t

val compare_p : ('a -> 'a -> int) -> 'a p -> 'a p -> int

val sexp_of_p : ('a -> Sexplib0.Sexp.t) -> 'a p -> Sexplib0.Sexp.t

val p_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a p

type t = all p

include Core_kernel.Bin_prot.Binable.S with type t := t

include Ppx_compare_lib.Comparable.S with type t := t

include Sexplib0.Sexpable.S with type t := t

Lifting from int

val of_int : int -> t Core_kernel.Or_error.t

of_int n return Ok `rn if `rn exists, Error otherwise.

val of_int_exn : int -> t

of_int_exn n the same as of_int, but raises exception instead of returning Error

val of_int_opt : int -> t option

of_int_opt n the same as of_int but uses option type instead of Or_error.t

val addr_of_int : int -> [ `r32 | `r64 ] Core_kernel.Or_error.t

addr_of_int n return Ok `rn if `rn exists, Error otherwise.

val addr_of_int_exn : int -> [ `r32 | `r64 ]

addr_of_int_exn n the same as addr_of_int, but raises exception instead of returning Error

val addr_of_int_opt : int -> [ `r32 | `r64 ] option

addr_of_int_opt n the same as addr_of_int but uses option type instead of Or_error.t

val addr_of_word_size : Core_kernel.Word_size.t -> [ `r32 | `r64 ]

val word_of_addr_size : [ `r32 | `r64 ] -> Core_kernel.Word_size.t

val to_addr_size : t -> [ `r32 | `r64 ] Core_kernel.Or_error.t

val in_bits : 'a p -> int

in_bits size returns size in bits.

val in_bytes : 'a p -> int

in_bytes sz returns size in bytes

include Regular.Std.Regular.S with type t := t

include Core_kernel.Bin_prot.Binable.S with type t := t

val bin_size_t : t Bin_prot.Size.sizer

val bin_write_t : t Bin_prot.Write.writer

val bin_read_t : t Bin_prot.Read.reader

val __bin_read_t__ : (int -> t) Bin_prot.Read.reader

val bin_shape_t : Bin_prot.Shape.t

val bin_writer_t : t Bin_prot.Type_class.writer

val bin_reader_t : t Bin_prot.Type_class.reader

val bin_t : t Bin_prot.Type_class.t

include Sexplib0.Sexpable.S with type t := t

val t_of_sexp : Sexplib0__.Sexp.t -> t

val sexp_of_t : t -> Sexplib0__.Sexp.t

include Ppx_compare_lib.Comparable.S with type t := t

include Regular.Std.Printable.S with type t := t

val to_string : t -> string

to_string x returns a human-readable representation of x

val str : unit -> t -> string

str () t is formatted output function that matches "%a" conversion format specifier in functions, that prints to string, e.g., sprintf, failwithf, errorf and, surprisingly all Lwt printing function, including Lwt_io.printf and logging (or any other function with type ('a,unit,string,...) formatN`. Example:

Or_error.errorf "type %a is not valid for %a"
    Type.str ty Exp.str exp

val pps : unit -> t -> string

synonym for str

val ppo : Core_kernel.Out_channel.t -> t -> unit

will print to a standard output_channel, useful for using in printf, fprintf, etc.

val pp_seq : Format.formatter -> t Core_kernel.Sequence.t -> unit

prints a sequence of values of type t

this will include pp function from Core that has type t printer, and can be used in Format.printf family of functions

include Core_kernel.Pretty_printer.S with type t := t

val pp : Base__.Formatter.t -> t -> unit

include Core_kernel.Comparable.S_binable with type t := t

val (>=) : t -> t -> bool

val (<=) : t -> t -> bool

val (=) : t -> t -> bool

val (>) : t -> t -> bool

val (<) : t -> t -> bool

val (<>) : t -> t -> bool

val equal : t -> t -> bool

val compare : t -> t -> int

val min : t -> t -> t

val max : t -> t -> t

val ascending : t -> t -> int

val descending : t -> t -> int

val between : t -> low:t -> high:t -> bool

val clamp_exn : t -> min:t -> max:t -> t

val clamp : t -> min:t -> max:t -> t Base__.Or_error.t

type comparator_witness

val validate_lbound : min:t Core__.Maybe_bound.t -> t Validate.check

val validate_ubound : max:t Core__.Maybe_bound.t -> t Validate.check

val validate_bound : 
  min:t Core__.Maybe_bound.t ->
  max:t Core__.Maybe_bound.t ->
  t Validate.check

module Replace_polymorphic_compare : sig ... end

val comparator : (t, comparator_witness) Core__.Comparator.comparator

module Map : sig ... end

module Set : sig ... end

include Core_kernel.Hashable.S_binable with type t := t

val hash_fold_t : t Base__Ppx_hash_lib.hash_fold

val hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value

val hashable : t Core__.Hashtbl.Hashable.t

module Table : sig ... end

module Hash_set : sig ... end

module Hash_queue : sig ... end

include Regular.Std.Data.S with type t := t

type info = string * [ `Ver of string ] * string option

name,Ver v,desc information attached to a particular reader or writer.

val version : string

Data representation version. After any change in data representation the version should be increased.

Serializers that are derived from a data representation must have the same version as a version of the data structure, from which it is derived. This kind of serializers can only read and write data of the same version.

Other serializers can actually read and write data independent on its representation version. A serializer, that can't store data of current version simply shouldn't be added to a set of serializers.

It is assumed, that if a reader and a writer has the same name and version, then whatever was written by the writer should be readable by the reader. The round-trip equality is not required, thus it is acceptable if some information is lost.

It is also possible, that a reader and a writer that has the same name are compatible. In that case it is recommended to use semantic versioning.

val size_in_bytes : ?ver:string -> ?fmt:string -> t -> int

size_in_bytes ?ver ?fmt datum returns the amount of bytes that is needed to represent datum in the given format and version

val of_bytes : ?ver:string -> ?fmt:string -> Regular.Std.bytes -> t

of_bytes ?ver ?fmt bytes deserializes a value from bytes.

val to_bytes : ?ver:string -> ?fmt:string -> t -> Regular.Std.bytes

to_bytes ?ver ?fmt datum serializes a datum to a sequence of bytes.

val blit_to_bytes : 
  ?ver:string ->
  ?fmt:string ->
  Regular.Std.bytes ->
  t ->
  int ->
  unit

blit_to_bytes ?ver ?fmt buffer datum offset copies a serialized representation of datum into a buffer, starting from the offset.

val of_bigstring : ?ver:string -> ?fmt:string -> Core_kernel.bigstring -> t

of_bigstring ?ver ?fmt buf deserializes a datum from bigstring

val to_bigstring : ?ver:string -> ?fmt:string -> t -> Core_kernel.bigstring

of_bigstring ?ver ?fmt datum serializes a datum to a sequence of bytes represented as bigstring

val blit_to_bigstring : 
  ?ver:string ->
  ?fmt:string ->
  Core_kernel.bigstring ->
  t ->
  int ->
  unit

blit_to_bigstring ?ver ?fmt buffer datum offset copies a serialized representation of datum into a buffer, starting from offset.

module Io : sig ... end

Input/Output functions for the given datum.

module Cache : sig ... end

Data cache.

val add_reader : 
  ?desc:string ->
  ver:string ->
  string ->
  t Regular.Std.reader ->
  unit

add_reader ?desc ~ver name reader registers a new reader with a provided name, version ver and optional description desc

val add_writer : 
  ?desc:string ->
  ver:string ->
  string ->
  t Regular.Std.writer ->
  unit

add_writer ?desc ~ver name writer registers a new writer with a provided name, version ver and optional description desc

val available_readers : unit -> info list

available_reader () lists available readers for the data type

val default_reader : unit -> info

default_reader returns information about default reader

val set_default_reader : ?ver:string -> string -> unit

set_default_reader ?ver name sets new default reader. If version is not specified then the latest available version is used. Raises an exception if a reader with a given name doesn't exist.

val with_reader : ?ver:string -> string -> (unit -> 'a) -> 'a

with_reader ?ver name operation temporary sets a default reader to a reader with a specified name and version. The default reader is restored after operation is finished.

val available_writers : unit -> info list

available_writer () lists available writers for the data type

val default_writer : unit -> info

default_writer returns information about the default writer

val set_default_writer : ?ver:string -> string -> unit

set_default_writer ?ver name sets new default writer. If version is not specified then the latest available version is used. Raises an exception if a writer with a given name doesn't exist.

val with_writer : ?ver:string -> string -> (unit -> 'a) -> 'a

with_writer ?ver name operation temporary sets a default writer to a writer with a specified name and version. The default writer is restored after operation is finished.

val default_printer : unit -> info option

default_writer optionally returns an information about default printer

val set_default_printer : ?ver:string -> string -> unit

set_default_printer ?ver name sets new default printer. If version is not specified then the latest available version is used. Raises an exception if a printer with a given name doesn't exist.

val with_printer : ?ver:string -> string -> (unit -> 'a) -> 'a

with_printer ?ver name operation temporary sets a default printer to a printer with a specified name and version. The default printer is restored after operation is finished.

Low level access to serializers

val find_reader : ?ver:string -> string -> t Regular.Std.reader option

find_reader ?ver name lookups a reader with a given name. If version is not specified, then a reader with maximum version is returned.

val find_writer : ?ver:string -> string -> t Regular.Std.writer option

find_writer ?ver name lookups a writer with a given name. If version is not specified, then a writer with maximum version is returned.

Install

dune-project
Dependency

Authors

Maintainers

Sources

doc/bap/Bap/Std/Size/index.html

Module `Std.Size`

Lifting from int

Low level access to serializers

package bap-std

Install

dune-project Dependency

Authors

Maintainers

Sources

doc/bap/Bap/Std/Size/index.html

Module Std.Size

Lifting from int

Low level access to serializers

dune-project
Dependency

Module `Std.Size`