fgoxide 0.6.0

Utility/QoL code for writing command-line / file processing tools.
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

//! There are many helper functions that are used repeatedly across projects, such as serializing an
//! iterator of `Serializable` objects to a file. This crate aims to collect those usage patterns,
//! refine the APIs around them, and provide well tested code to be used across projects.
#![forbid(unsafe_code)]

pub mod io;
pub mod iter;

use thiserror::Error;

/// Error types for `fgoxide`
#[derive(Error, Debug)]
pub enum FgError {
    #[error("Error invoking underlying IO operation.")]
    IoError(#[from] std::io::Error),

    #[error("Error parsing/formatting delimited data.")]
    ConversionError(#[from] csv::Error),

    #[error("Error parsing delimited data file header.")]
    DelimFileHeaderError { expected: String, found: String },
}

/// Result type that should be used everywhere
type Result<A> = std::result::Result<A, FgError>;