package containers

  1. Overview
  2. Docs
package containers
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module CCUtf8_stringSource

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
Sourcetype uchar = Uchar.t
Sourcetype 'a gen = unit -> 'a option
Sourcetype 'a sequence = ('a -> unit) -> unit
  • deprecated

    use 'a iter instead

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

Fast internal iterator.

  • since 2.8
Sourcetype t = private string

A UTF8 string

Sourceval equal : t -> t -> bool
Sourceval hash : t -> int
Sourceval compare : t -> t -> int
Sourceval pp : Format.formatter -> t -> unit
Sourceval to_string : t -> string

Identity.

Sourceexception Malformed of string * int

Malformed string at given offset

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

Generator of unicode codepoints.

  • parameter idx

    offset where to start the decoding.

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

Iterator of unicode codepoints.

  • parameter idx

    offset where to start the decoding.

  • since 2.8
Sourceval to_seq : ?idx:int -> t -> uchar sequence
  • deprecated use to_iter or to_std_seq instead
Sourceval to_std_seq : ?idx:int -> t -> uchar Seq.t

Iter of unicode codepoints.

  • parameter idx

    offset where to start the decoding.

  • since 2.8
Sourceval to_list : ?idx:int -> t -> uchar list

List of unicode codepoints.

  • parameter idx

    offset where to start the decoding.

Sourceval fold : ?idx:int -> ('a -> uchar -> 'a) -> 'a -> t -> 'a
Sourceval iter : ?idx:int -> (uchar -> unit) -> t -> unit
Sourceval n_chars : t -> int

Number of characters.

Sourceval n_bytes : t -> int

Number of bytes.

Sourceval map : (uchar -> uchar) -> t -> t
Sourceval filter_map : (uchar -> uchar option) -> t -> t
Sourceval flat_map : (uchar -> t) -> t -> t
Sourceval append : t -> t -> t
Sourceval concat : t -> t list -> t
Sourceval of_std_seq : uchar Seq.t -> t

Build a string from unicode codepoints

  • since 2.8
Sourceval of_iter : uchar sequence -> t

Build a string from unicode codepoints

  • since 2.8
Sourceval of_seq : uchar sequence -> t
  • deprecated use of_iter or of_std_seq instead
Sourceval of_gen : uchar gen -> t
Sourceval of_list : uchar list -> t
Sourceval of_string_exn : string -> t

Validate string by checking it is valid UTF8.

Sourceval of_string : string -> t option

Safe version of of_string_exn.

Sourceval is_valid : string -> bool

Valid UTF8?

Sourceval 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.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct