molframe-pdb 0.6.2

Legacy PDB reading and writing for molframe
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Incremental PDB output over the shared bounded text adapter.

use super::pdb::{PdbOptions, render_selected};
use molframe_core::diagnostic::{Code, Diagnostic};
use molframe_core::io::{Select, SelectAll, TextOutput};
use molframe_core::structure::Structure;
use std::io::Write;

/// Streams a complete PDB directly to a byte destination.
///
/// # Errors
///
/// Returns every fixed-column refusal before the first byte, or an output
/// diagnostic if the destination stops accepting bytes.
pub fn write_to<W: Write>(
    structure: &Structure,
    options: &PdbOptions,
    output: &mut W,
) -> Result<(), Vec<Diagnostic>> {
    write_selected_to(structure, options, &SelectAll, output)
}

/// Streams selected PDB records without materialising the complete text.
///
/// # Errors
///
/// Returns capacity, required-field, or destination diagnostics.
pub fn write_selected_to<W: Write>(
    structure: &Structure,
    options: &PdbOptions,
    select: &impl Select,
    output: &mut W,
) -> Result<(), Vec<Diagnostic>> {
    let mut output = TextOutput::new(output);
    render_selected(&mut output, structure, options, select)?;
    output
        .finish()
        .map_err(|error| vec![output_diagnostic(error)])
}

fn output_diagnostic(error: impl std::fmt::Display) -> Diagnostic {
    Diagnostic::new(Code::E7901).with_context("reason", error.to_string())
}