https://github.com/tamschi/tiptoe
An easy-to-support intrusively reference-counting smart pointer.
https://github.com/tamschi/tiptoe
hacktoberfest intrusive-containers intrusive-ptr reference-counting rust threading
Last synced: 2 months ago
JSON representation
An easy-to-support intrusively reference-counting smart pointer.
- Host: GitHub
- URL: https://github.com/tamschi/tiptoe
- Owner: Tamschi
- License: other
- Created: 2021-10-12T18:40:19.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-07-26T13:37:05.000Z (11 months ago)
- Last Synced: 2025-03-28T02:48:05.601Z (3 months ago)
- Topics: hacktoberfest, intrusive-containers, intrusive-ptr, reference-counting, rust, threading
- Language: Rust
- Homepage:
- Size: 97.7 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# tiptoe
[](https://lib.rs/crates/tiptoe)
[](https://crates.io/crates/tiptoe)
[](https://docs.rs/tiptoe)
[](https://github.com/Tamschi/tiptoe/actions?query=workflow%3ACI+branch%3Adevelop)
[](https://github.com/Tamschi/tiptoe)
[](https://github.com/Tamschi/tiptoe/issues)
[](https://github.com/Tamschi/tiptoe/pulls)
[](https://github.com/Tamschi/tiptoe/contribute)
[](https://web.crev.dev/rust-reviews/crate/tiptoe/)
[](https://iteration-square.schichler.dev/#narrow/stream/project.2Ftiptoe)
An easy-to-support intrusively reference-counting smart pointer.
## Installation
Please use [cargo-edit](https://crates.io/crates/cargo-edit) to always add the latest version of this library:
```cmd
cargo add tiptoe --features sync
```
## Features
### `"sync"`
Enables the [`Arc`](https://docs.rs/tiptoe/latest/tiptoe/struct.Arc.html) type, which requires [`AtomicUsize`](https://doc.rust-lang.org/stable/core/sync/atomic/struct.AtomicUsize.html).
## Example
```rust
use pin_project::pin_project;
use tiptoe::{IntrusivelyCountable, TipToe};
// All attributes optional.
#[pin_project]
#[derive(Debug, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct A {
#[pin]
ref_counter: TipToe,
}
unsafe impl IntrusivelyCountable for A {
type RefCounter = TipToe;
fn ref_counter(&self) -> &Self::RefCounter {
&self.ref_counter
}
}
fn main() {
#[cfg(feature = "sync")]
{
use tiptoe::Arc;
let arc = Arc::new(A::default());
let inner_ref: &A = &arc;
let another_arc = unsafe {
Arc::borrow_from_inner_ref(&inner_ref)
}.clone();
}
}
```
## Implementation Progress
This library is currently only implemented about as far as I need it for rhizome.
Please have a look at the [issues](https://github.com/Tamschi/tiptoe/issues) if you'd like to help out.
Notable current omissions: `Rc`, `Weak`, and most optimisation that doesn't affect the API.
## License
Licensed under either of
- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license
([LICENSE-MIT](LICENSE-MIT) or )
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.
See [CONTRIBUTING](CONTRIBUTING.md) for more information.
## [Code of Conduct](CODE_OF_CONDUCT.md)
## [Changelog](CHANGELOG.md)
## Versioning
`tiptoe` strictly follows [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) with the following exceptions:
- The minor version will not reset to 0 on major version changes (except for v1).
Consider it the global feature level.
- The patch version will not reset to 0 on major or minor version changes (except for v0.1 and v1).
Consider it the global patch level.
This includes the Rust version requirement specified above.
Earlier Rust versions may be compatible, but this can change with minor or patch releases.
Which versions are affected by features and patches can be determined from the respective headings in [CHANGELOG.md](CHANGELOG.md).
Note that dependencies of this crate may have a more lenient MSRV policy!
Please use `cargo +nightly update -Z minimal-versions` in your automation if you don't generate Cargo.lock manually (or as necessary) and require support for a compiler older than current stable.