package coin

  1. Overview
  2. Docs
Mapper of KOI8-{U,R} to Unicode

Install

dune-project
 Dependency

Authors

Maintainers

Sources

coin-v0.1.2.tbz
sha256=cc86addf2f7bd1bdf69585af731c9d6beac463af900fe3b78545ee1767fd2ecb
sha512=3d59cf13d792ad968c3d03658e8dc891ab14839842c1f8771cb20c1c28887bda118be82acc43f05f66bb559cfdb1594ea5e97243933d5f10063bfe1dd087b0a7

doc/coin/Coin/index.html

Module CoinSource

Sourcetype encoding = [
  1. | `KOI8_U
  2. | `KOI8_R
]

The type of KOI8.

Sourceval encoding_of_string : string -> encoding

encoding_of_string s converts a (case insensitive) IANA character set name to an encoding.

Sourceval encoding_to_string : encoding -> string

encoding_to_string e is a IANA character set name for e.

Sourcetype 'kind decoder constraint 'kind = [< encoding ]

The type for decoders.

Sourcetype src = [
  1. | `Manual
  2. | `Channel of in_channel
  3. | `String of string
]

The type for input sources. With a `Manual source the client must provide input with src.

Sourcetype decode = [
  1. | `Await
  2. | `End
  3. | `Uchar of Uchar.t
  4. | `Malformed of string
]
Sourceval pp_decode : Format.formatter -> decode -> unit
Sourceval src : 'kind decoder -> Bytes.t -> int -> int -> unit

src d s j l provides d with l bytes to read, starting at j in s. This byte range is read by calls to decode with d until `Await is returned. To signal the end of input call the function with l = 0.

Sourceval decoder : ([< encoding ] as 'kind) -> src -> 'kind decoder

decoder encoding src is a decoder that inputs from src.

Encoding. encoding specifies the decoded encoding scheme.

Sourceval decode : 'kind decoder -> decode

decode d is:

  • `Await if d has a `Manual input source and awaits for more input. The client must use src to provide it.
  • `Uchar u if a Unicode scalar value u was decoder.
  • `End if the end of input was reached.
  • `Malformed err if d encountered an error err.

Note. Repeated invocation always eventually returns `End, even in case of errors.

Sourceval decoder_byte_count : 'kind decoder -> int

decoder_byte_count d is the number of characters already decoder on d (including malformed ones). This is the last decode's and byte offset counting from beginning of the stream.

Sourceval decoder_src : 'kind decoder -> src

decoder_src d is d's input source.

Sourceval decoder_kind : 'kind decoder -> 'kind

decoder_kind d is d's the decoded encoding scheme of d.

Sourcemodule Char : sig ... end
Sourcemodule String : sig ... end