package devkit

  1. Overview
  2. Docs
Development kit - general purpose library

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (9)

Authors

  1. A
    Ahrefs <github@ahrefs.com>

Maintainers

  1. I
    igor@ahrefs.com

Sources

1.20261006.tar.gz
md5=a39dbbce04bd5562a9b4443daf39c582
sha512=b10104b61384b2151521b785e7f3c3250134c75eae09b42cad69bc4a22a9a5e429beb891ee87cedf376c23d9c40f09d3f71c3fd48aa35df490c0f69dc17f3242

doc/devkit.ocamlnet_lite/Ocamlnet_lite/Netstring_tstring/index.html

Module Ocamlnet_lite.Netstring_tstringSource

Support module for tagged strings

Sourcetype _ tstring_kind =
  1. | String_kind : string tstring_kind
  2. | Bytes_kind : Bytes.t tstring_kind

GADT for encoding the string type (string/bytes/bigarray)

Sourcetype 't tstring_ops = {
  1. kind : 't tstring_kind option;
  2. length : 't -> int;
  3. get : 't -> int -> char;
  4. unsafe_get : 't -> int -> char;
  5. unsafe_get3 : 't -> int -> int;
    (*

    get 3 chars packed into one int (first char shifted by 16 bits, second char shifted by 8 bits, third char unshifted)

    *)
  6. copy : 't -> 't;
  7. string : 't -> string;
    (*

    if possible this function does not make a copy

    *)
  8. bytes : 't -> Bytes.t;
    (*

    if possible this function does not make a copy

    *)
  9. sub : 't -> int -> int -> 't;
  10. substring : 't -> int -> int -> string;
  11. subbytes : 't -> int -> int -> Bytes.t;
  12. subpoly : 'u. 'u tstring_kind -> 't -> int -> int -> 'u;
  13. blit_to_bytes : 't -> int -> Bytes.t -> int -> int -> unit;
  14. index_from : 't -> int -> char -> int;
  15. index_from3 : 't -> int -> int -> char -> char -> char -> int;
    (*

    finds any of three chars. The second int is the search radius

    *)
  16. rindex_from : 't -> int -> char -> int;
  17. rindex_from3 : 't -> int -> int -> char -> char -> char -> int;
    (*

    finds any of three chars. The second int is the search radius

    *)
}

Operations to call on strings

Sourcetype tstring_ops_box =
  1. | Tstring_ops_box : 't tstring_kind * 't tstring_ops -> tstring_ops_box

GADT for hiding the type parameter

Sourcetype tstring_box =
  1. | Tstring_box : 't tstring_kind * 't tstring_ops * 't -> tstring_box

GADT for hiding the type parameter

Sourcetype tstring_polybox =
  1. | Tstring_polybox : 't tstring_ops * 't -> tstring_polybox

GADT for hiding the type parameter. Warning: This GADT does not permit you to recover the kind of string

Sourceval string_ops : string tstring_ops

Implementation of the operations for string

Sourceval bytes_ops : Bytes.t tstring_ops

Implementation of the operations for bytes

Create a Tstring_ops_box

Sourcetype 'a with_fun = {
  1. with_fun : 's. 's tstring_ops -> 's -> 'a;
}

A polymorphic function for strings

Sourceval with_tstring : 'a with_fun -> Netsys_types.tstring -> 'a

with_tstring f ts: Calls f.with_fun with the right implementation of the tstring_ops argument

Sourceval length_tstring : Netsys_types.tstring -> int

Get the length of a tagged string

Get the tagged string of a tagged buffer

Sourceval polymorph_string_transformation : (string -> string) -> 's tstring_ops -> 't tstring_kind -> 's -> 't

polymorph_string_transformation f ops kind s: Converts s to a string, runs f on this string, and converts the result to the type demanded by kind