summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Gong <jordan.gong@protonmail.com>2020-09-09 21:36:11 +0800
committerJordan Gong <jordan.gong@protonmail.com>2020-09-09 21:36:11 +0800
commit0caa5fb8e4e084248e6c4e7d3314854eb7bc4e7f (patch)
treeed8e283258b2cf219acd226cc9525237625c25d4
parent003e092786221abaef21e197a810f40b1cc9b57f (diff)
Publish my crate
-rw-r--r--my_crate/.gitignore18
-rw-r--r--my_crate/Cargo.toml9
-rw-r--r--my_crate/src/lib.rs61
-rw-r--r--my_crate/src/main.rs8
4 files changed, 96 insertions, 0 deletions
diff --git a/my_crate/.gitignore b/my_crate/.gitignore
new file mode 100644
index 0000000..e629269
--- /dev/null
+++ b/my_crate/.gitignore
@@ -0,0 +1,18 @@
+
+# Created by https://www.toptal.com/developers/gitignore/api/rust
+# Edit at https://www.toptal.com/developers/gitignore?templates=rust
+
+### Rust ###
+# Generated by Cargo
+# will have compiled files and executables
+/target/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# End of https://www.toptal.com/developers/gitignore/api/rust
+
diff --git a/my_crate/Cargo.toml b/my_crate/Cargo.toml
new file mode 100644
index 0000000..57c0dfe
--- /dev/null
+++ b/my_crate/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "my_crate"
+version = "0.1.0"
+authors = ["Jordan Gong <jordan.gong@protonmail.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
diff --git a/my_crate/src/lib.rs b/my_crate/src/lib.rs
new file mode 100644
index 0000000..a6f0751
--- /dev/null
+++ b/my_crate/src/lib.rs
@@ -0,0 +1,61 @@
+////! # My crate
+////!
+////! `my_crate` is a collection of utilities to make performing certain
+////! calculations more convenient.
+
+///// Adds one to number given.
+/////
+///// # Examples
+/////
+///// ```
+///// let arg = 5;
+///// let answer = my_crate::add_one(arg);
+/////
+///// assert_eq!(6, answer);
+///// ```
+//pub fn add_one(x: i32) -> i32 {
+// x + 1
+//}
+
+//! # Art
+//!
+//! A library for modeling artistic concepts.
+
+pub use self::kinds::PrimaryColor;
+pub use self::kinds::SecondaryColor;
+pub use self::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 {
+ // --snip--
+ SecondaryColor::Orange
+ }
+}
+
+#[cfg(test)]
+mod tests {
+ #[test]
+ fn it_works() {
+ assert_eq!(2 + 2, 4);
+ }
+}
diff --git a/my_crate/src/main.rs b/my_crate/src/main.rs
new file mode 100644
index 0000000..f7a50d3
--- /dev/null
+++ b/my_crate/src/main.rs
@@ -0,0 +1,8 @@
+use my_crate::PrimaryColor;
+use my_crate::mix;
+
+fn main() {
+ let red = PrimaryColor::Red;
+ let yellow = PrimaryColor::Yellow;
+ mix(red, yellow);
+}