biolic 0.1.0

A modular bioinformatics toolkit in Rust for long-read sequence processing
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
44
45
46
47
48
49
50
51
52
53
54

//! Output formatting (human-readable, JSON, TSV).

use anyhow::Result;
use serde::Serialize;

/// Output format selected by the user.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OutputFormat {
    Human,
    Json,
    Tsv,
}

impl OutputFormat {
    /// Detect default format based on whether stdout is a terminal.
    pub fn auto() -> Self {
        if atty_isatty() {
            OutputFormat::Human
        } else {
            OutputFormat::Tsv
        }
    }
}

/// Best-effort TTY detection without an extra dependency.
fn atty_isatty() -> bool {
    use std::io::IsTerminal;
    std::io::stdout().is_terminal()
}

/// Write a serializable value to stdout in the chosen format.
pub fn write<T: Serialize + HumanDisplay>(value: &T, format: OutputFormat) -> Result<()> {
    match format {
        OutputFormat::Json => {
            let json = serde_json::to_string_pretty(value)?;
            println!("{}", json);
        }
        OutputFormat::Tsv => {
            value.write_tsv(&mut std::io::stdout())?;
        }
        OutputFormat::Human => {
            value.write_human(&mut std::io::stdout())?;
        }
    }
    Ok(())
}

/// Trait for types that can render themselves as human-readable text and TSV.
///
/// JSON output is provided automatically via `serde::Serialize`.
pub trait HumanDisplay {
    fn write_human(&self, w: &mut dyn std::io::Write) -> Result<()>;
    fn write_tsv(&self, w: &mut dyn std::io::Write) -> Result<()>;
}