Skip to content

Commit

Permalink
pr47: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
seliopou committed Jul 5, 2021
1 parent fc9a19d commit fabb5d7
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions lib/bigstringaf.mli
Original file line number Diff line number Diff line change
Expand Up @@ -164,11 +164,11 @@ val blit_to_bytes : t -> src_off:int -> Bytes.t -> dst_off:int -> len:int -> uni
val memcmp : t -> int -> t -> int -> int -> int
val memcmp_string : t -> int -> string -> int -> int -> int

(** {4 [memchr]}
(** {3 [memchr]}
Search for a byte using [memchr], returning [-1] if the byte is not found.
Performing bounds checking before the C call. *)

Search for a byte in a bigstring using [memchr]. Similar to [unsafe_memchr]
but this performs bounds checks.
*)
val memchr : t -> int -> char -> int -> int

(** {2 Memory-unsafe Operations}
Expand Down Expand Up @@ -274,8 +274,9 @@ val unsafe_blit_to_bytes : t -> src_off:int -> Bytes.t -> dst_off:int -> len:int
val unsafe_memcmp : t -> int -> t -> int -> int -> int
val unsafe_memcmp_string : t -> int -> string -> int -> int -> int

(** {4 [memchr]}
(** {3 [memchr]}
Search for a byte using [memchr], returning [-1] if the byte is not found.
It does not check bounds before the C call. *)

Search for a byte in a bigstring using [memchr].
*)
val unsafe_memchr : t -> int -> char -> int -> int

0 comments on commit fabb5d7

Please sign in to comment.