package datakit-ci

  1. Overview
  2. Docs
package datakit-ci
Legend:
Library
Module
Module type
Parameter
Class
Class type
type colour = [
  1. | `Black
  2. | `Blue
  3. | `Cyan
  4. | `Green
  5. | `Magenta
  6. | `Red
  7. | `White
  8. | `Yellow
]
type sgr = [
  1. | `BgCol of [ `Default | colour ]
  2. | `Bold
  3. | `FgCol of [ `Default | colour ]
  4. | `Italic
  5. | `NoBold
  6. | `NoItalic
  7. | `NoReverse
  8. | `NoUnderline
  9. | `Reset
  10. | `Reverse
  11. | `Underline
]
type escape = [
  1. | `Reset
  2. | `Ctrl of [ `SelectGraphicRendition of sgr list ]
]
val parse : CI_char_stream.t -> [ `Literal of CI_char_stream.t | `Escape of escape * CI_char_stream.t | `Invalid of CI_char_stream.t | `Incomplete ]

parse stream returns the first token in stream and the stream directly after it, or `Incomplete if more data is required to parse the first token. `Literal s2 indicates that everything between stream and s2 should be output as literal text. `Escape (e, s2) indicates that the first token was escape sequence e. `Invalid s2 indicates that the first token was malformed or not understood and processing should continue from s2.