Enum Format 

#[non_exhaustive]
pub enum Format {
    Auto,
    Mmcif,
    Pdbml,
    BinaryCif,
    Mmtf,
    Pdb,
    Pqr,
    Pdbqt,
    Sdf,
    Mol2,
    SmallCif,
}

A format molframe can read or write.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Auto

Decide from the content, then from the file name.

Mmcif

The archive’s structured text format.

Pdbml

XML serialization of the PDBx data model.

BinaryCif

The archive’s MessagePack-based binary format.

Mmtf

The deprecated but still encountered macromolecular transmission format.

Pdb

The legacy fixed-column format.

Pqr

PDB-shaped coordinates carrying partial charge and radius.

Pdbqt

AutoDock’s PDB-shaped coordinates carrying charge and atom type.

Sdf

MDL structure-data file: one or more CTfile records.

Mol2

Tripos MOL2 molecule records.

SmallCif

Core-CIF small-molecule crystal data with fractional coordinates.

Implementations

impl Format

pub const NAMED: [Self; 10]

The formats a caller may name, excluding automatic detection.

pub const fn name(self) -> &'static str

The format’s short name.

pub const fn extensions(self) -> &'static [&'static str]

The file suffixes conventionally used for this format.

pub fn parse(name: &str) -> Option<Self>

Parses a format name without allocating a normalized copy.

pub fn recognises(self, bytes: &[u8]) -> bool

Returns true when this format’s content is recognisable in bytes.

pub fn detect( requested: Self, input: &InputBuffer, name: Option<&str>, ) -> Result<Self, Diagnostic>

Decides the format of input, given what the caller asked for and the name the bytes came from.

Errors

Returns a diagnostic when neither content nor the optional name identifies a supported format.

pub fn from_name(name: &str) -> Option<Self>

The format a file name suggests, ignoring any compression suffix.

pub fn from_extension(extension: &str) -> Option<Self>

The format a bare extension names (pdb, cif, bcif, …), compared without regard to case.

impl Format

pub const NAMES: &'static [&'static str]

The names a format can be spelled with, besides the file suffixes (cif, ent, mol, …) that Format::parse also accepts.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Format

fn default() -> Self

Returns the “default value” for a type.

impl Display for Format

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Format

impl FromStr for Format

fn from_str(value: &str) -> Result<Self, Self::Err>

Case-insensitive; a conventional file suffix names its format.

type Err = PolicyParseError

The associated error which can be returned from parsing.

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Format

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Format