https://github.com/mbrubeck/by_address

Rust wrapper type that implements hashing and comparison by pointer address
https://github.com/mbrubeck/by_address

Last synced: about 1 month ago
JSON representation

Rust wrapper type that implements hashing and comparison by pointer address

• Host: GitHub
• URL: https://github.com/mbrubeck/by_address
• Owner: mbrubeck
• License: apache-2.0
• Created: 2017-10-23T19:33:34.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-27T19:11:59.000Z (9 months ago)
• Last Synced: 2024-11-10T20:51:39.492Z (about 1 month ago)
• Language: Rust
• Homepage:
• Size: 25.4 KB
• Stars: 34
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# by_address

Rust wrapper type that implements hashing and comparison based on address

rather than value.

* [API Documentation](https://docs.rs/by_address)

* [crates.io package](https://crates.io/crates/by_address)

* [Source code](https://github.com/mbrubeck/by_address)

# Overview

`ByAddress` can be used to wrap any pointer type (i.e. any type that implements the Deref

trait).  This includes references, raw pointers, smart pointers like `Rc`

and `Box`, and specialized pointer-like types such as `Vec` and `String`.

The wrapped pointer implements the following traits based on the address of

its contents, rather than their value:

* Hash

* Eq, PartialEq

* Ord, PartialOrd

## no_std

This crate does not depend on libstd, so it can be used in [`no_std`]

projects.

[`no_std`]: https://doc.rust-lang.org/book/first-edition/using-rust-without-the-standard-library.html

## Release notes

### Version 1.2.1

* Mark `ByThinAddress` as `repr(transparent)`.

### Version 1.2.0

* Add `from_ref` constructor.

### Version 1.1.2

* Improved documentations.

### Version 1.1.1

* Update to Rust 2021.

### Version 1.1.0

* New `ByThinAddress` type.

* Implement the `Display` trait.

* Custom implementation of `Debug` that includess the pointer address.

### Version 1.0.4

* Improve hashing of fat pointers

### Version 1.0.3

* Implement `From` for `ByAddress`

* More documentation fixes

### Version 1.0.2

* More documentation fixes

### Version 1.0.1

* Improved documentation

### Version 1.0.0

* Initial release

## License

Licensed under the Apache License, Version 2.0 or the MIT license, at your

option.  See the license files in this directory for details.