igc_parser 0.1.7

//! # <span style="color:orange">IGC Parser</span>
//! A <span style="color:orange"><strong>*high-level*</strong></span> parsing crate for IGC flight recorder files.
//! <br /> With most focus on:
//! - <span style="color:orange"><strong>*Easy*</strong></span> to use
//! - <span style="color:orange"><strong>*No run-time asserts*</strong></span> meaning that any errors will be through the ```Result``` type
//! - A  <span style="color:orange"><em><strong>*panic free*</strong></em></span> crate
//!
//! You should use this crate if you want to <span style="color:orange"><strong>*easily, quickly*</strong></span> and <span style="color:orange"><strong>*safely*</strong></span> parse igc files.
//!
//! Look in `records` to see the different kind of records that can be parsed
//!
//! # examples
//! This is if you want all fixes that have parsed correctly. A similar approach is used for the other records.
//! ```rust
//! use std::fs;
//! use igc_parser::records::{fix::Fix, Record};
//! let file = fs::read_to_string("./examples/example.igc").unwrap().parse::<String>().unwrap();
//! let valid_fixes = file.lines().filter_map(|line| {
//!     match Record::parse(line) {
//!         Ok(Record::B(fix)) => Some(fix),
//!         _ => None,
//!         }
//!     }).collect::<Vec<Fix>>();
//! println!("{}", valid_fixes.len())
//! ```

use std::rc::Rc;

#[cfg(feature = "thread-safe")]
use std::sync::Arc;

use crate::error::IGCError;

type Result<T> = core::result::Result<T, IGCError>;

#[cfg(feature = "thread-safe")]
type StrWrapper = Arc<str>;

#[cfg(not(feature = "thread-safe"))]
type StrWrapper = Rc<str>;

/// All different type of IGC records
pub mod records;
/// For parsing entire file at once
pub mod igc_file;
/// Parsing errors
pub mod error;
/// Builder for a parser to parse only specific kinds of records
pub mod parser_builder;