code_abinash 0.1.0

A collection of utilities to make performing certain calculations more convenient.
Documentation
//! # codeAbinash
//!
//! `code_abinash` is a collection of utilities to make performing certain calculations more convenient.

/// Adds one to the number given.
///   
/// # Examples
///
/// ```
/// let arg = 5;
/// let answer = code_abinash::add_one(arg);
/// assert_eq!(6, answer);
/// ```
/// # Panics
/// If the input is `i32::MAX` value.
///
/// # Errors
/// If the input is `i32::MIN` value.
///
/// # Safety
/// The function is not safe to use with `i32::MAX` value.
///
pub fn add_one(x: i32) -> i32 {
    x + 1
}

/// # Art
///
/// A library for modeling artistic concepts.
pub use kinds::PrimaryColor;
pub use kinds::SecondaryColor;
pub use utils::mix;
pub mod kinds {
    /// The primary colors according to the RYB color model.
    pub enum PrimaryColor {
        Red,
        Yellow,
        Blue,
    }

    /// The secondary colors according to the RYB color model.
    pub enum SecondaryColor {
        Orange,
        Green,
        Purple,
    }
}

pub mod utils {
    use crate::kinds::*;

    /// Combines two primary colors in equal amounts to create
    /// a secondary color.
    pub fn mix(_c1: PrimaryColor, _c2: PrimaryColor) -> SecondaryColor {
        // ANCHOR: here
        return SecondaryColor::Orange;
        // ANCHOR_END: here
    }
}