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
//! # Introduction
//!
//! LeetCode Trees's purpose is making LeetCode problems easier to work around with via some simple
//! library exports that allow for a smoother development experience by allowing you to use your
//! primary IDE rather than the LeetCode website to solve the problems.
//!
//! ## Installation
//!
//! These are the two ways to can add this library to your project:
//!
//! Number 1 - Via the `Cargo.toml` file by adding this;
//!
//! ```toml
//! [dependencies]
//! leetcode-trees-rs = "0.1"
//! ```
//!
//! Number 2 - Via running the following command in your terminal:
//!
//! ```sh
//! cargo add leetcode-trees-rs
//! ```
//!
//! ## Usage
//!
//! The usage is very simple. These are the primary components:
//! - [`prelude`]
//! - [`utils::TreeNode`]
//!
//!
//! Additionally, via the support of the cargo make library you can comfortably run your LeetCode
//! tests by running:
//!
//! ```sh
//! cargo make leetcode_problem_number
//! ```
//!
//! Assuming there's a LeetCode submittion for it. All the solutions are managed on the GitHub page
//! of this libray.
//!
//!
//!
//! [`prelude`]: crate::prelude
//! [`TreeNode`]: crate::utils::TreeNode
#![warn(missing_docs)]
/// The module that contains the error type.
pub mod error;
/// The module that contains all the useful macros.
pub mod macros;
/// Contains re-exports for all the important structs.
pub mod prelude;
#[allow(missing_docs)]
#[cfg(test)]
pub mod tests;
/// Contains the structs and macro re-exports that you can use in creating LeetCode solutions
/// related to binary trees.
pub mod utils;
pub use crate::prelude::*;