module

Chem::FormatReader::Headed(T)

Declares a common interface for reading the header information encoded in a file format. This is useful for cases when a file format includes valuable information (by itself) in the header.

Including types must implement the #decode_header : T protected method, where the type variable T indicates the header type. Upon parsing issues, including types are expected to raise a ParseException exception.

Instance methods

read_header

Reads the header object from the IO. Raises IO::Error if the reader is closed or ParseException if the header cannot be decoded.

Source