rust-3d 0.34.0

/*
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::{
    fmt,
    io::Error as ioError,
    num::{ParseFloatError, ParseIntError},
    result,
};

use crate::io::*;

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

/// 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,
    ClusterTooBig,
    CantCalculateAngleIfZeroLength,
    TriFace3DNotSpanningVolume,
    PlyError(PlyError),
    StlError(StlError),
    PtxError(PtxError),
    XyError(XyError),
    XyzError(XyzError),
    ObjError(ObjError),
    OffError(OffError),
    PslError(PslError),
    GcodeError(GcodeError),
}

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

impl fmt::Debug for ErrorKind {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::MinMaxSwapped => write!(f, "Passed min/max values are swapped (min > max)"),
            Self::MinMaxEqual => write!(f, "Passed min/max values are equal"),
            Self::TooFewPoints => write!(f, "Container had too few points for the operation"),
            Self::BoundingBoxMissing => write!(f, "Bounding box is missing for the operation"),
            Self::NormalizeVecWithoutLength => write!(f, "Can't normalize a vector of length 0"),
            Self::IOError => write!(f, "Can't read or write a file"),
            Self::ParseError => write!(f, "Can't parse data"),
            Self::IndexOutOfBounds => write!(f, "Tried to access an out of bounds index"),
            Self::IncorrectFaceID => write!(f, "Used an incorrect face id"),
            Self::IncorrectVertexID => write!(f, "Used an incorrect vertex id"),
            Self::IncorrectEdgeID => write!(f, "Used an incorrect edge id"),
            Self::IncorrectVoxelID => write!(f, "Used an incorrect voxel id"),
            Self::IncorrectUnitID => write!(f, "Used an incorrect unit id"),
            Self::IncorrectSegmentID => write!(f, "Used an incorrect segment id"),
            Self::IncorrectDimension => write!(f, "Trying to access an incorrect dimension"),
            Self::DimensionsDontMatch => write!(f, "Trying to mix types with different dimensions"),
            Self::NumberConversionError => {
                write!(f, "Failed converting one number type to another")
            }
            Self::NumberInWrongRange => write!(f, "Passed number is within the wrong range"),
            Self::ComparisionFailed => write!(f, "Comparision between two values failed"),
            Self::CantCalculateAngleIfZeroLength => {
                write!(f, "Can't calculate the angle between 0 vectors")
            }
            Self::ClusterTooBig => write!(f, "Clustering size is too big for given mesh"),
            Self::TriFace3DNotSpanningVolume => write!(
                f,
                "TriFace3D must be constructed from points spanning a volume"
            ),
            Self::PlyError(x) => x.fmt(f),
            Self::StlError(x) => x.fmt(f),
            Self::PtxError(x) => x.fmt(f),
            Self::XyError(x) => x.fmt(f),
            Self::XyzError(x) => x.fmt(f),
            Self::ObjError(x) => x.fmt(f),
            Self::OffError(x) => x.fmt(f),
            Self::PslError(x) => x.fmt(f),
            Self::GcodeError(x) => x.fmt(f),
        }
    }
}

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

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

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

impl From<ParseIntError> for ErrorKind {
    fn from(_error: ParseIntError) -> ErrorKind {
        ErrorKind::ParseError
    }
}

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

impl From<PlyError> for ErrorKind {
    fn from(error: PlyError) -> Self {
        Self::PlyError(error)
    }
}

impl From<StlError> for ErrorKind {
    fn from(error: StlError) -> Self {
        Self::StlError(error)
    }
}

impl From<XyError> for ErrorKind {
    fn from(error: XyError) -> Self {
        Self::XyError(error)
    }
}

impl From<XyzError> for ErrorKind {
    fn from(error: XyzError) -> Self {
        Self::XyzError(error)
    }
}

impl From<ObjError> for ErrorKind {
    fn from(error: ObjError) -> Self {
        Self::ObjError(error)
    }
}

impl From<OffError> for ErrorKind {
    fn from(error: OffError) -> Self {
        Self::OffError(error)
    }
}

impl From<GcodeError> for ErrorKind {
    fn from(error: GcodeError) -> Self {
        Self::GcodeError(error)
    }
}