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
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

/*
Copyright 2016 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.
*/

//! Result, the result type used within rust-3d. Also defining the error enum and several transformation methods between error types.

use std::result;
use std::fmt;
use std::num::ParseFloatError;
use std::num::ParseIntError;
use std::io::Error as ioError;

/// The Error Enum used by rust-3d
pub enum ErrorKind {
    MinMaxSwapped,
    MinMaxEqual,
    TooFewPoints,
    BoundingBoxMissing,
    NormalizeVecWithoutLength,
    IOError,
    ParseError,
    IndexOutOfBounds,
    IncorrectFaceID,
    IncorrectVertexID,
    IncorrectEdgeID,
    IncorrectVoxelID,
    IncorrectUnitID,
    IncorrectSegmentID,
    IncorrectDimension,
    DimensionsDontMatch,
    NumberConversionError,
    NumberInWrongRange,
    ComparisionFailed,
    ColorArrayIncorrectLength,
    PlyError(PlyError)
}

pub enum PlyError {
    LoadError,
    LoadStartNotFound,
    LoadFormatNotFound,
    LoadWrongPropertyCount,
    LoadVertexIndexDefinitionNotFound,
    LoadHeaderEndNotFound,
    LoadVertexCountNotFound,
    LoadFaceCountNotFound,
    LoadVertexCountIncorrect,
    LoadVerticesIncorrect,
}

impl ErrorKind {
    /// Returns readable text for the ErrorKind
    pub fn as_str(&self) -> &'static str {
        match self {
            ErrorKind::MinMaxSwapped             => "Passed min/max values are swapped (min > max)",
            ErrorKind::MinMaxEqual               => "Passed min/max values are equal",
            ErrorKind::TooFewPoints              => "Container had too few points for the operation",
            ErrorKind::BoundingBoxMissing        => "Bounding box is missing for the operation",
            ErrorKind::NormalizeVecWithoutLength => "Can't normalize a vector of length 0",
            ErrorKind::IOError                   => "Can't read or write a file",
            ErrorKind::ParseError                => "Can't parse data",
            ErrorKind::IndexOutOfBounds          => "Tried to access an out of bounds index",
            ErrorKind::IncorrectFaceID           => "Used an incorrect face id",
            ErrorKind::IncorrectVertexID         => "Used an incorrect vertex id",
            ErrorKind::IncorrectEdgeID           => "Used an incorrect edge id",
            ErrorKind::IncorrectVoxelID          => "Used an incorrect voxel id",
            ErrorKind::IncorrectUnitID           => "Used an incorrect unit id",
            ErrorKind::IncorrectSegmentID        => "Used an incorrect segment id",
            ErrorKind::IncorrectDimension        => "Trying to access an incorrect dimension",
            ErrorKind::DimensionsDontMatch       => "Trying to mix types with different dimensions",
            ErrorKind::NumberConversionError     => "Failed converting one number type to another",
            ErrorKind::NumberInWrongRange        => "Passed number is within the wrong range",
            ErrorKind::ComparisionFailed         => "Comparision between two values failed",
            ErrorKind::ColorArrayIncorrectLength => "The provided color array has an incorrect length",
            ErrorKind::PlyError(x)               => x.as_str()
        }
    }
}

impl PlyError {
    /// Returns readable text for the PlyError
    pub fn as_str(&self) -> &'static str {
        match self {
            PlyError::LoadError                 => "Error while loading .ply",
            PlyError::LoadStartNotFound         => "Start of .ply header not found",
            PlyError::LoadFormatNotFound        => "Format of .ply missing or not supported",
            PlyError::LoadWrongPropertyCount    => "Property count of .ply missing or not supported",
            PlyError::LoadVertexIndexDefinitionNotFound => "Index definition in .ply not found",
            PlyError::LoadHeaderEndNotFound     => "End of header definition of .ply not found",
            PlyError::LoadVertexCountNotFound   => "Vertex count of .ply not found",
            PlyError::LoadFaceCountNotFound     => "Face count of .ply not found",
            PlyError::LoadVertexCountIncorrect  => "Vertex count of .ply not found",
            PlyError::LoadVerticesIncorrect     => "Vertices in .ply incorrect"
        }
    }
}

impl fmt::Debug for ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.as_str())
    }
}

/// Result type used by rust-3d
pub type Result<T> = result::Result<T, ErrorKind>;

/// Trait used to convert other Errors to ErrorKind
pub trait ToErrorKind {
    /// Creates an ErrorKind from this
    fn to_error_kind(&self) -> ErrorKind;
}

impl ToErrorKind for ParseFloatError {
    fn to_error_kind(&self) -> ErrorKind {
        ErrorKind::ParseError
    }
}

impl ToErrorKind for ParseIntError {
    fn to_error_kind(&self) -> ErrorKind {
        ErrorKind::ParseError
    }
}

impl ToErrorKind for ioError {
    fn to_error_kind(&self) -> ErrorKind {
        ErrorKind::IOError
    }
}

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