+23 -23

vendor/opam/cstruct/lib/cstruct.mli

··· 181 181 (default [Bigarray.Array1.dim b - off]). *) 182 182 183 183 val to_bigarray: t -> buffer 184 184 - (** [to_bigarray t] converts a {!t} into a {!buffer} Bigarray, using 184 184 + (** [to_bigarray t] converts a {!t} into a {!type:buffer} Bigarray, using 185 185 the Bigarray slicing to allocate a fresh array that preserves 186 186 sharing of the underlying buffer. *) 187 187 ··· 362 362 @raise Invalid_argument if [off] or [len] is negative, or 363 363 [Cstruct.len str - off] < [len]. *) 364 364 365 365 - (** {2 Debugging } *) 366 366 - 367 367 - val hexdump: t -> unit 368 368 - (** When the going gets tough, the tough hexdump their cstructs 369 369 - and peer at it until the bug disappears. This will directly 370 370 - prettyprint the contents of the cstruct to the standard output. *) 371 371 - 372 372 - val hexdump_to_buffer: Buffer.t -> t -> unit 373 373 - (** [hexdump_to_buffer buf c] will append the pretty-printed hexdump 374 374 - of the cstruct [c] to the buffer [buf]. *) 375 375 - 376 376 - val hexdump_pp: Format.formatter -> t -> unit 377 377 - (** [hexdump_pp f c] pretty-prints a hexdump of [c] to [f]. *) 378 378 - 379 379 - val debug: t -> string 380 380 - (** [debug t] will print out the internal details of a cstruct such 381 381 - as its base offset and the length, and raise an assertion failure 382 382 - if invariants have been violated. Not intended for casual use. *) 383 383 - 384 365 module BE : sig 385 366 386 367 (** Get/set big-endian integers of various sizes. The second ··· 492 473 @raise Invalid_argument if the buffer is too small. *) 493 474 end 494 475 476 476 + (** {2 Debugging } *) 477 477 + 478 478 + val hexdump: t -> unit 479 479 + (** When the going gets tough, the tough hexdump their cstructs 480 480 + and peer at it until the bug disappears. This will directly 481 481 + prettyprint the contents of the cstruct to the standard output. *) 482 482 + 483 483 + val hexdump_to_buffer: Buffer.t -> t -> unit 484 484 + (** [hexdump_to_buffer buf c] will append the pretty-printed hexdump 485 485 + of the cstruct [c] to the buffer [buf]. *) 486 486 + 487 487 + val hexdump_pp: Format.formatter -> t -> unit 488 488 + (** [hexdump_pp f c] pretty-prints a hexdump of [c] to [f]. *) 489 489 + 490 490 + val debug: t -> string 491 491 + (** [debug t] will print out the internal details of a cstruct such 492 492 + as its base offset and the length, and raise an assertion failure 493 493 + if invariants have been violated. Not intended for casual use. *) 494 494 + 495 495 (** {2 List of buffers} *) 496 496 497 497 val lenv: t list -> int ··· 611 611 (** [string ~off ~len str] is the subbuffer of [str] that starts at position [off] 612 612 (defaults to [0]) and stops at position [off + len] (defaults to 613 613 [String.length str]). [str] is fully-replaced by an fresh allocated 614 614 - {!Cstruct.buffer}. 614 614 + {!type:buffer}. 615 615 616 616 @raise Invalid_argument if [off] or [off + len] are not positions of [str]. 617 617 *) ··· 626 626 [buffer]. *) 627 627 628 628 val start_pos : t -> int 629 629 - (** [start_pos cs] is [cs]'s start position in the base {!Cstruct.buffer}. *) 629 629 + (** [start_pos cs] is [cs]'s start position in the base {!type:buffer}. *) 630 630 631 631 val stop_pos : t -> int 632 632 - (** [stop_pos cs] is [cs]'s stop position in the base {!Cstruct.buffer}. *) 632 632 + (** [stop_pos cs] is [cs]'s stop position in the base {!type:buffer}. *) 633 633 634 634 val length : t -> int 635 635 (** Returns the length of the current cstruct view. Note that this

+4 -4

vendor/opam/cstruct/lib/cstruct_cap.mli

··· 35 35 The functions that retrieve bytes ({!get_uint8} etc.) require a [read] 36 36 capability, functions mutating the underlying buffer ({!set_uint8} etc.) 37 37 require a [write] capability. Allocation of a buffer (via {!create}, ...) 38 38 - returns a [t] with read and write capabilities. {!ro} drops the write 39 39 - capability, {!wo} drops the read capability. The only exception is 38 38 + returns a [t] with read and write capabilities. {!val:ro} drops the write 39 39 + capability, {!val:wo} drops the read capability. The only exception is 40 40 {!unsafe_to_bigarray} that returns the underlying [Bigarray.t]. 41 41 42 42 Accessors and mutators for fixed size integers (8, 16, 32, 64 bit) are ··· 524 524 525 525 {ul 526 526 {- if [rev] is [false] (default), [l] is at least [min] and at most 527 527 - [max] consecutive [sat] satisfying initial bytes of [cs] or {!empty} 527 527 + [max] consecutive [sat] satisfying initial bytes of [cs] or {!is_empty} 528 528 if there are no such bytes. [r] are the remaining bytes of [cs].} 529 529 {- if [rev] is [true], [r] is at least [min] and at most [max] 530 530 - consecutive [sat] satisfying final bytes of [cs] or {!empty} 530 530 + consecutive [sat] satisfying final bytes of [cs] or {!is_empty} 531 531 if there are no such bytes. [l] are the remaining bytes of [cs].}} 532 532 533 533 If [max] is unspecified the span is unlimited. If [min] is unspecified

+1 -2

vendor/opam/cstruct/lib/cstruct_sexp.mli

··· 17 17 (** Sexpression serialisers for {!Cstruct.t} values *) 18 18 19 19 type buffer = Cstruct.buffer 20 20 - (** [buffer] is an alias for the corresponding {!Cstruct.buffer} type *) 20 20 + (** [buffer] is an alias for the corresponding {!type:Cstruct.buffer} type *) 21 21 22 22 val sexp_of_buffer : Cstruct.buffer -> Sexplib.Sexp.t 23 23 (** [sexp_of_buffer b] returns the s-expression representation of the raw memory buffer [b] *) ··· 35 35 val t_of_sexp : Sexplib.Sexp.t -> t 36 36 (** [t_of_sexp s] returns a fresh {!Cstruct.t} that represents the 37 37 s-expression previously serialised by {!sexp_of_t}. *) 38 38 -