|
1 | 1 | #![no_std] |
2 | | -#![cfg_attr(feature = "fatal-warnings", deny(warnings))] |
3 | | -// Note: If you change this remember to update `README.md`. To do so run `cargo rdme`. |
| 2 | +// Note: If you change this remember to update `README.md`. To do so run `cargo rdme`. |
4 | 3 | //! `archery` is a rust library that offers a way to abstraction over |
5 | 4 | //! [`Rc`](::alloc::rc::Rc) and |
6 | 5 | //! [`Arc`](::alloc::sync::Arc) smart pointers. |
|
31 | 30 | //! |
32 | 31 | //! `archery` defines a [`SharedPointer`](crate::shared_pointer::SharedPointer) |
33 | 32 | //! that receives the [kind of pointer](crate::shared_pointer::kind::SharedPointerKind) |
34 | | -//! as a type parameter. This gives you a convenient and ergonomic way to abstract the pointer |
| 33 | +//! as a type parameter. This gives you a convenient and ergonomic way to abstract the pointer |
35 | 34 | //! type away. |
36 | 35 | //! |
37 | 36 | //! ## Example |
|
95 | 94 | //! |
96 | 95 | //! ## Serialization |
97 | 96 | //! |
98 | | -//! We support serialization through [serde](https://crates.io/crates/serde). To use it |
99 | | -//! enable the `serde` feature. To do so change the archery dependency in your `Cargo.toml` to |
| 97 | +//! We support serialization through [serde](https://crates.io/crates/serde). To use it |
| 98 | +//! enable the `serde` feature. To do so change the archery dependency in your `Cargo.toml` to |
100 | 99 | //! |
101 | 100 | //! ```toml |
102 | 101 | //! [dependencies] |
|
105 | 104 | //! # Limitations |
106 | 105 | //! |
107 | 106 | //! Currently it is not possible to have unsized types inside a |
108 | | -//! [`SharedPointer`](crate::shared_pointer::SharedPointer). As a workaround you can put the |
| 107 | +//! [`SharedPointer`](crate::shared_pointer::SharedPointer). As a workaround you can put the |
109 | 108 | //! unsized type inside a [`Box`](::alloc::boxed::Box). |
110 | 109 | //! |
111 | 110 | //! # Alternative approaches |
112 | 111 | //! |
113 | 112 | //! An alternative to the approach taken by `archery` is to use traits with associated types to encode |
114 | | -//! type-level functions. This has been suggested |
| 113 | +//! type-level functions. This has been suggested |
115 | 114 | //! [multiple](https://github.com/orium/rpds/issues/7#issuecomment-362635901) |
116 | 115 | //! [times](https://joshlf.com/post/2018/10/18/rust-higher-kinded-types-already/#comment-4160863400), |
117 | 116 | //! but offers ugly ergonomics (see |
|
0 commit comments