module Chem::FormatReader::Headed(T)

Overview

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.

Direct including types

• Chem::Cube::Reader
• Chem::DX::Reader
• Chem::PDB::Reader
• Chem::VASP::Chgcar::Reader
• Chem::VASP::Locpot::Reader

Defined in:

chem/format_reader.cr

Instance Method Summary

• #read_header : T

  Reads the header object from the IO.

Instance Method Detail