Module Binary.SlicerSource

Sourcetype slice = {
  1. name : string;
  2. value : string;
  3. pretty_printed : string;
}

A slice is a part of a binary representation of some data. The concatenation of multiple slices represents the whole data.

Sourcetype slicer_state
Sourceval make_slicer_state : string -> offset:int -> length:int -> slicer_state option

None if offset and length do not describe a valid substring.

Sourceval slice : _ Encoding.t -> slicer_state -> (slice list, Data_encoding__.Binary_error_types.read_error) result

slice e state slices the data represented by the substring described by state.

If e does not correctly describe the given bytes (i.e., if read would fail on equivalent parameters) then it returns Error.

Otherwise it returns Ok sl and String.concat "" (List.map (fun s -> s.value) sl is byte-for-byte identical to the substring described by state.

Sourceval slice_opt : _ Encoding.t -> slicer_state -> slice list option
Sourceval slice_exn : _ Encoding.t -> slicer_state -> slice list
Sourceval slice_string : _ Encoding.t -> string -> (slice list, read_error) result

slice_string slices the whole content of the string.

In other words, slice_string e s is slice e (Option.get @@ make_slicer_state s 0 (String.length s).

Sourceval slice_string_opt : _ Encoding.t -> string -> slice list option
Sourceval slice_string_exn : _ Encoding.t -> string -> slice list
Sourceval slice_bytes : _ Encoding.t -> bytes -> (slice list, read_error) result
Sourceval slice_bytes_opt : _ Encoding.t -> bytes -> slice list option
Sourceval slice_bytes_exn : _ Encoding.t -> bytes -> slice list