Module type Api.NATIVE_CONVERSIONS

module type NATIVE_CONVERSIONS = sig .. end

API definition of conversions from native OCaml strings to a given string type or vice-versa.

type t

The string type.

val of_native_string : string -> (t, [> `wrong_char_at of int ]) Api.result

Convert a native string to the current representation. of_native_string returns `Error (`wrong_char_at index) when the native string contains a character not representable with the type character at index.

val of_native_substring : string ->
       offset:int ->
       length:int ->
       (t, [> `out_of_bounds | `wrong_char_at of int ])
       Api.result

Convert a native string like of_native_string but take a subset of the string.

val to_native_string : t -> string

Serialize the string to a native string.