View Source Figlet.Parser.HeaderlineParser (figlet v0.3.2)

This module is dedicated to parsing the metadata from a Figlet file headerline.

The header line gives information about the FIGfont. Here is an example showing the names of all parameters:

          flf2a$ 6 5 20 15 3 0 143 229    NOTE: The first five characters in
            |  | | | |  |  | |  |   |     the entire file must be "flf2a".
           /  /  | | |  |  | |  |      Signature  /  /  | |  |  | |      Codetag_Count
    Hardblank  /  /  |  |  |     Full_Layout*
         Height  /   |  |     Print_Direction
         Baseline   /       Comment_Lines
          Max_Length      Old_Layout*

See Also

Summary

Functions

Parses the headerline (provided as a string binary).

Functions

parse(header_line, opts \\ [])

@spec parse(header_line :: binary(), opts :: keyword()) ::
  {:ok, Figlet.Meta.t()} | {:error, binary()}

Parses the headerline (provided as a string binary).