Expand description
Patoz is a strict, type safe PDB file parser. Converts text PDB file into a traversable record struct.
Modules§
- author
- Contains parsers related to Author records. The AUTHOR record contains the names of the people responsible for the contents of the entry.
- caveat
- Contains parsers related to Caveat records. CAVEAT warns of errors and unresolved issues in the entry. Use caution when using an entry containing this record.
- compnd
- Contains parsers related to Compnd records. The COMPND record describes the macromolecular contents of an entry. Also contains tokens parsers which are utilized from other records such as SOURCE records
- expdta
- Contains parsers related to Expdta records.
- header
- Contains parsers related to Header records. Header record gives information about identity of this pdb file.
- jrnl
- Contains parsers related to Jrnl records.
- keywds
- Contains parsers related to Keywds records. The KEYWDS record contains a set of terms relevant to the entry.
- mdltyp
- Contains parsers related to Mdltyp records.
- nummdl
- Contains parsers related to Nummdl records Nummdl record is a single line record having number of models inside the pdb entry. There is only one record per pdb.
- obslte
- Contains parsers related to Obslte records. Obslte record indicates that this entry is removed from PDB and replaced with another entry.
- primitive
- contains lowest level parsers that are used by multiple record parsers
- revdat
- Contains parsers related to Revdat records.
- seqres
- source
- Contains parsers related to Source records. The SOURCE record specifies the biological or chemical source of each molecule in this entry..
- split
- Contains parsers related to Split records. The SPLIT record is used in instances where a specific entry composes part of a large macromolecular complex. It will identify the PDB entries that are required to reconstitute a complete complex.
- sprsde
- Contains parsers related to Sprsde records. The SPRSDE records contain a list of the ID codes of entries that were made obsolete by the given coordinate entry and removed from the PDB release set.
- title
- Contains parsers related to Title records.The TITLE record contains a title for the experiment or analysis that is represented in the entry.
Macros§
Structs§
- Author
- Holds name of an author utilized by multiple parsers such as author and journal author parsers
- Authors
- author collection
- Caveat
- fallacies of this entry
- Cmpnd
- collection of tokens in a CMPND record
- Experimental
- experimanetal techniques used for exploring structure of this entry
- Header
- contains HEADER recor information
- Journal
Authors - journal author collection
- Journal
Citation - journal Citation fields
- Journal
Doi - digital object identifier of related e-pub
- Journal
Editors - journal editor collection
- Journal
PubMed Id - journal PubMed id
- Journal
Publication - journal publication fields
- Journal
Reference - journal reference
- Journal
Title - journal title
- Keywds
- keywords related to the entry
- Mdltyp
- model type of the entry
- Nummdl
- number of models in this file
- Obslte
- contains pdb entry ids which removed this one from PDB
- PdbFile
- PdbHeader
- PdbJournal
- Revdat
- Represents a modification made to this pdb entry.
- Revdats
- collection of revisions
- Seqres
- Source
- collection of tokens in a SOURCE record
- Split
- if this entry is a part of bigger structure, this struct holds ids of other parts of the bigger structure
- Sprsde
- pdb entry ids made obsolete by this entry
- Title
- result of a TITLE record
Enums§
- Experimental
Technique - Experimental techniques utilized in obtaining structure data
- Modification
Type - modification type of REVDAT record
- Record
- main enum unifying all record parser results. all sub parsers return a cariant of this
- Serial
Number - Serial Number Type of a JRNL REFN record
- Token
- Represents keys of CMPND and SOURCE records
Traits§
Functions§
- parse
- main parse function
Type Aliases§
- IResult
- Holds the result of parsing functions