rust_3d/io/
xyz.rs

1/*
2Copyright 2017 Martin Buck
3
4Permission is hereby granted, free of charge, to any person obtaining a copy
5of this software and associated documentation files (the "Software"),
6to deal in the Software without restriction, including without limitation the
7rights to use, copy, modify, merge, publish, distribute, sublicense,
8and/or sell copies of the Software, and to permit persons to whom the Software
9is furnished to do so, subject to the following conditions:
10
11The above copyright notice and this permission notice shall
12be included all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
20OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21*/
22
23//! Module for IO of the xyz file format
24
25use crate::*;
26
27use std::{
28    fmt,
29    io::{BufRead, Error as ioError, Write},
30};
31
32use super::{types::*, utils::*};
33
34//------------------------------------------------------------------------------
35
36/// 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
37pub fn save_xyz<RA, P, W>(
38    write: &mut W,
39    ra: &RA,
40    delim_coord: &str,
41    delim_pos: &str,
42) -> XyzResult<()>
43where
44    RA: IsRandomAccessible<P>,
45    P: Is3D,
46    W: Write,
47{
48    let n = ra.len();
49    for i in 0..n {
50        let ref p = ra[i];
51        let buffer = p.x().to_string()
52            + delim_coord
53            + &p.y().to_string()
54            + delim_coord
55            + &p.z().to_string()
56            + delim_pos;
57        write.write_all(buffer.as_bytes())?;
58    }
59    Ok(())
60}
61
62/// Loads a IsPushable<Is3D> as x y z coordinates. E.g. used to load the .xyz file format or .csv file
63pub fn load_xyz<IP, P, R>(read: &mut R, ip: &mut IP) -> XyzIOResult<()>
64where
65    IP: IsPushable<P>,
66    P: IsBuildable3D,
67    R: BufRead,
68{
69    let mut delim_determined = false;
70    let mut delim = 0;
71    let mut line_buffer = Vec::new();
72
73    let mut i_line = 0;
74
75    while let Ok(line) = fetch_line(read, &mut line_buffer) {
76        i_line += 1;
77
78        if !delim_determined {
79            delim = estimate_delimiter(2, &line)
80                .ok_or(XyzError::EstimateDelimiter)
81                .line(i_line, line)?;
82            delim_determined = true;
83        }
84
85        let mut words = line.split(|x| *x == delim).skip_empty();
86
87        let x = words
88            .next()
89            .and_then(|word| from_ascii(word))
90            .ok_or(XyzError::Vertex)
91            .line(i_line, line)?;
92
93        let y = words
94            .next()
95            .and_then(|word| from_ascii(word))
96            .ok_or(XyzError::Vertex)
97            .line(i_line, line)?;
98
99        let z = words
100            .next()
101            .and_then(|word| from_ascii(word))
102            .ok_or(XyzError::Vertex)
103            .line(i_line, line)?;
104
105        ip.push(P::new(x, y, z));
106    }
107
108    Ok(())
109}
110
111//------------------------------------------------------------------------------
112
113/// Error type for .xyz file operations
114pub enum XyzError {
115    EstimateDelimiter,
116    AccessFile,
117    Vertex,
118}
119
120/// Result type for .xyz file operations
121pub type XyzResult<T> = std::result::Result<T, XyzError>;
122
123/// Result type for .xyz file operations
124pub type XyzIOResult<T> = IOResult<T, XyzError>;
125
126impl fmt::Debug for XyzError {
127    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
128        match self {
129            Self::Vertex => write!(f, "Unable to parse vertex"),
130            Self::AccessFile => write!(f, "Unable to access file"),
131            Self::EstimateDelimiter => write!(f, "Unable to estimate delimiter"),
132        }
133    }
134}
135
136impl fmt::Display for XyzError {
137    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
138        write!(f, "{:?}", self)
139    }
140}
141
142impl From<ioError> for XyzError {
143    fn from(_error: ioError) -> Self {
144        XyzError::AccessFile
145    }
146}
rust_3d/io/xyz.rs

rust_3d/io/
xyz.rs
