rust-3d 0.34.0

/*
Copyright 2017 Martin Buck

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall
be included all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

//! Module for IO of the xyz file format

use crate::*;

use std::{
    fmt,
    io::{BufRead, Error as ioError, Write},
};

use super::{types::*, utils::*};

//------------------------------------------------------------------------------

/// Saves an IsRandomAccessible<Is3D> as x y z coordinates with a specified delimiter between coordinates and positions. E.g. used to create the .xyz file format or .csv files
pub fn save_xyz<RA, P, W>(
    write: &mut W,
    ra: &RA,
    delim_coord: &str,
    delim_pos: &str,
) -> XyzResult<()>
where
    RA: IsRandomAccessible<P>,
    P: Is3D,
    W: Write,
{
    let n = ra.len();
    for i in 0..n {
        let ref p = ra[i];
        let buffer = p.x().to_string()
            + delim_coord
            + &p.y().to_string()
            + delim_coord
            + &p.z().to_string()
            + delim_pos;
        write.write_all(buffer.as_bytes())?;
    }
    Ok(())
}

/// Loads a IsPushable<Is3D> as x y z coordinates. E.g. used to load the .xyz file format or .csv file
pub fn load_xyz<IP, P, R>(read: &mut R, ip: &mut IP) -> XyzIOResult<()>
where
    IP: IsPushable<P>,
    P: IsBuildable3D,
    R: BufRead,
{
    let mut delim_determined = false;
    let mut delim = 0;
    let mut line_buffer = Vec::new();

    let mut i_line = 0;

    while let Ok(line) = fetch_line(read, &mut line_buffer) {
        i_line += 1;

        if !delim_determined {
            delim = estimate_delimiter(2, &line)
                .ok_or(XyzError::EstimateDelimiter)
                .line(i_line, line)?;
            delim_determined = true;
        }

        let mut words = line.split(|x| *x == delim).skip_empty();

        let x = words
            .next()
            .and_then(|word| from_ascii(word))
            .ok_or(XyzError::Vertex)
            .line(i_line, line)?;

        let y = words
            .next()
            .and_then(|word| from_ascii(word))
            .ok_or(XyzError::Vertex)
            .line(i_line, line)?;

        let z = words
            .next()
            .and_then(|word| from_ascii(word))
            .ok_or(XyzError::Vertex)
            .line(i_line, line)?;

        ip.push(P::new(x, y, z));
    }

    Ok(())
}

//------------------------------------------------------------------------------

/// Error type for .xyz file operations
pub enum XyzError {
    EstimateDelimiter,
    AccessFile,
    Vertex,
}

/// Result type for .xyz file operations
pub type XyzResult<T> = std::result::Result<T, XyzError>;

/// Result type for .xyz file operations
pub type XyzIOResult<T> = IOResult<T, XyzError>;

impl fmt::Debug for XyzError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::Vertex => write!(f, "Unable to parse vertex"),
            Self::AccessFile => write!(f, "Unable to access file"),
            Self::EstimateDelimiter => write!(f, "Unable to estimate delimiter"),
        }
    }
}

impl fmt::Display for XyzError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

impl From<ioError> for XyzError {
    fn from(_error: ioError) -> Self {
        XyzError::AccessFile
    }
}