package fmlib_parse

You can search for identifiers within the package.

in-package search v0.2.0

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

Partially or completely scanned unicode character.

val is_complete : t -> bool

Has the unicode character been completely scanned?

val has_error : t -> bool

Has the scanning of the unicode character encountered an encoding error?

val uchar : t -> Uchar.t

The unicode character. In case of an error or a not yet completed scan, the unicode character rep = U+FFFD is returned.

val scalar : t -> int

The scalar value of the unicode character.

val width : t -> int

The width of the unicode character. The width is either 0, 1, or 4.

A tab has width 4.

Other ascii control characters (below space) have witdh 0 (not visible).

val byte_width : t -> int

Number of bytes used during decoding.

val is_newline : t -> bool

Is the decoded character a newline character.

Valid newline characters are line feed (LF), vertical tab (VT), form feed (FF), next line (NEL), line separator (LS) and paragraph separator (PS).

val init : t

Initial value representing the completely scanned unicode character U+0000.

val put : char -> t -> t

put byte dec Feed the scanner with the next byte of the encoded unicode character.