easy_node/lib.rs
1/*! Smart pointer for graph nodes.
2
3*The author of this crate is not good at English.*
4*Forgive me if the document is hard to read.*
5
6This crate provides some smart pointers optimized for
7managing graph data structures.
8
9* [`Nr`] - like [`Rc`]
10* [`Nw`] - like [`Weak`].
11
12These smart pointers behavior is similar to [`Rc`] and [`Weak`].<br/>
13However, These smart pointer comparison is based on location.
14
15## Comparison of smart pointers
16
17This crate smart pointer comparison is based on location.<br/>
18This allows smart pointers to be used as [`HashSet`] values, etc.
19
20For example, comparison of [`Nr::eq`] is based on identity of node address.<br/>
21On the other hand comparison of [`Rc::eq`] is based on inner value.
22
23[`Rc`]: std::rc::Rc
24[`Rc::eq`]: std::rc::Rc::eq
25[`Weak`]: std::rc::Weak
26[`HashSet`]: std::collections::HashSet
27*/
28
29#![warn(missing_docs)]
30
31mod nr;
32mod nw;
33pub mod prelude;
34mod util;
35
36pub use nr::*;
37pub use nw::*;