package containers

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Unicode String, in UTF8

containers
- CCArray
  - Infix
  - MONO_ARRAY
- CCArrayLabels
- CCBool
- CCChar
- CCEqual
  - Infix
- CCEqualLabels
  - Infix
- CCFloat
  - Infix
- CCFormat
  - Dump
- CCFun
  - Infix
  - Monad
    
    X
- CCHash
- CCHashtbl
  - Make
  - Poly
  - S
- CCHeap
  - Make
    
    E
  - Make_from_compare
    
    E
  - PARTIAL_ORD
  - S
  - TOTAL_ORD
- CCIO
  - File
- CCInt
  - Infix
- CCInt32
  - Infix
- CCInt64
  - Infix
- CCList
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCListLabels
  - Assoc
  - Infix
  - MONAD
  - Ref
  - Traverse
    
    M
- CCMap
  - Make
  - S
- CCNativeint
  - Infix
- CCOpt
  - Infix
- CCOrd
  - Infix
- CCPair
- CCParse
  - Infix
  - U
- CCRandom
- CCRef
- CCResult
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSeq
  - Infix
  - MONAD
  - Traverse
    
    M
- CCSet
  - Make
  - S
- CCSexp
  - Decoder
  - Make
    
    Decoder
    
    Sexp
- CCSexp_intf
  - S
    
    Decoder
  - SEXP
- CCSexp_lex
- CCShimsArrayLabels_
  - Floatarray
- CCShimsArray_
- CCShimsFormat_
- CCShimsFun_
- CCShimsInt_
- CCShimsList_
- CCShimsMkLet_
  - Make
    
    X
  - Make2
    
    X
  - S
  - S2
- CCShims_
- CCString
  - Find
  - Infix
  - Split
- CCStringLabels
  - Find
  - Infix
  - Split
- CCUtf8_string
- CCVector
- Containers
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
- ContainersLabels
  - Hashtbl
    
    HashedType
    
    Make
    
    MakeSeeded
    
    H
    
    S
    
    SeededHashedType
    
    SeededS
containers.monomorphic
- CCMonomorphic
- CCMonomorphicShims_
containers.top
- Containers_top
containers.unix
- CCUnix
  - Infix

Legend:
Library
Module
Module type
Parameter
Class
Class type

Unicode String, in UTF8

A unicode string represented by a utf8 bytestring. This representation is convenient for manipulating normal OCaml strings that are encoded in UTF8.

We perform only basic decoding and encoding between codepoints and bytestrings. For more elaborate operations, please use the excellent Uutf.

status: experimental

since 2.1

type uchar = Stdlib.Uchar.t

type 'a gen = unit -> 'a option

type 'a iter = ('a -> unit) -> unit

Fast internal iterator.

since 2.8

type t = private string

A UTF8 string

val equal : t -> t -> bool

val hash : t -> int

val compare : t -> t -> int

val pp : Stdlib.Format.formatter -> t -> unit

val to_string : t -> string

Identity.

exception Malformed of string * int

Malformed string at given offset

val to_gen : ?idx:int -> t -> uchar gen

Generator of unicode codepoints.

parameter idx
offset where to start the decoding.

val to_iter : ?idx:int -> t -> uchar iter

Iterator of unicode codepoints.

parameter idx
offset where to start the decoding.

since 2.8

val to_seq : ?idx:int -> t -> uchar Stdlib.Seq.t

Iter of unicode codepoints. Renamed from to_std_seq since 3.0.

parameter idx
offset where to start the decoding.

since 3.0

val to_list : ?idx:int -> t -> uchar list

List of unicode codepoints.

parameter idx
offset where to start the decoding.

val fold : ?idx:int -> ('a -> uchar -> 'a) -> 'a -> t -> 'a

val iter : ?idx:int -> (uchar -> unit) -> t -> unit

val n_chars : t -> int

Number of characters.

val n_bytes : t -> int

Number of bytes.

val map : (uchar -> uchar) -> t -> t

val filter_map : (uchar -> uchar option) -> t -> t

val flat_map : (uchar -> t) -> t -> t

val append : t -> t -> t

val concat : t -> t list -> t

val of_seq : uchar Stdlib.Seq.t -> t

Build a string from unicode codepoints Renamed from of_std_seq since 3.0.

since 3.0

val of_iter : uchar iter -> t

Build a string from unicode codepoints

since 2.8

val of_gen : uchar gen -> t

val of_list : uchar list -> t

val of_string_exn : string -> t

Validate string by checking it is valid UTF8.

raises Invalid_argument
if the string is not valid UTF8.

val of_string : string -> t option

Safe version of of_string_exn.

val is_valid : string -> bool

Valid UTF8?

val unsafe_of_string : string -> t

Conversion from a string without validating. CAUTION this is unsafe and can break all the other functions in this module. Use only if you're sure the string is valid UTF8. Upon iteration, if an invalid substring is met, Malformed will be raised.