by_address-1.2.1/.cargo_vcs_info.json0000644000000001360000000000100131540ustar { "git": { "sha1": "bb921a29ea2fc1ee30a4dac9ff6d97c6730b5c7f" }, "path_in_vcs": "" }by_address-1.2.1/.gitignore000064400000000000000000000000241046102023000137300ustar 00000000000000/target/ **/*.rs.bk by_address-1.2.1/Cargo.toml0000644000000016740000000000100111620ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2021" name = "by_address" version = "1.2.1" authors = ["Matt Brubeck "] description = "Wrapper for comparing and hashing pointers by address" documentation = "https://docs.rs/by_address" readme = "README.md" keywords = [ "hash", "pointer", "reference", "rc", "arc", ] categories = [ "no-std", "data-structures", "rust-patterns", ] license = "MIT OR Apache-2.0" repository = "https://github.com/mbrubeck/by_address" by_address-1.2.1/Cargo.toml.orig000064400000000000000000000007031046102023000146330ustar 00000000000000[package] name = "by_address" version = "1.2.1" authors = ["Matt Brubeck "] license = "MIT OR Apache-2.0" description = "Wrapper for comparing and hashing pointers by address" repository = "https://github.com/mbrubeck/by_address" documentation = "https://docs.rs/by_address" keywords = ["hash", "pointer", "reference", "rc", "arc"] categories = ["no-std", "data-structures", "rust-patterns"] readme = "README.md" edition = "2021" by_address-1.2.1/LICENSE-APACHE000064400000000000000000000251371046102023000137000ustar 00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. by_address-1.2.1/LICENSE-MIT000064400000000000000000000020401046102023000133740ustar 00000000000000Copyright (c) 2017 Matt Brubeck Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. by_address-1.2.1/README.md000064400000000000000000000032251046102023000132250ustar 00000000000000# 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. by_address-1.2.1/src/lib.rs000064400000000000000000000244161046102023000136560ustar 00000000000000//! Wrapper type for by-address hashing and comparison. //! //! [`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`. //! //! Comparison, ordering, and hashing of the wrapped pointer will be based on the address of its //! contents, rather than their value. //! //! ``` //! use by_address::ByAddress; //! use std::rc::Rc; //! //! let rc = Rc::new(5); //! let x = ByAddress(rc.clone()); //! let y = ByAddress(rc.clone()); //! //! // x and y are two pointers to the same address: //! assert_eq!(x, y); //! //! let z = ByAddress(Rc::new(5)); //! //! // *x and *z have the same value, but not the same address: //! assert_ne!(x, z); //! ``` //! //! If `T` is a pointer to an unsized type, then comparison of `ByAddress` uses the //! entire fat pointer, not just the "thin" data address. This means that two slice pointers //! are consider equal only if they have the same starting address *and* length. //! //! ``` //! # use by_address::ByAddress; //! # //! let v = [1, 2, 3, 4]; //! //! assert_eq!(ByAddress(&v[0..4]), ByAddress(&v[0..4])); // Same address and length. //! assert_ne!(ByAddress(&v[0..4]), ByAddress(&v[0..2])); // Same address, different length. //! ``` //! //! You can use [`ByThinAddress`] instead if you want to compare slices by starting address only, //! or trait objects by data pointer only. //! //! You can use wrapped pointers as keys in hashed or ordered collections, like BTreeMap/BTreeSet //! or HashMap/HashSet, even if the target of the pointer doesn't implement hashing or ordering. //! This even includes pointers to trait objects, which usually don't implement the Eq trait //! because it is not object-safe. //! //! ``` //! # use by_address::ByAddress; //! # use std::collections::HashSet; //! # //! /// Call each item in `callbacks`, skipping any duplicate references. //! fn call_each_once(callbacks: &[&dyn Fn()]) { //! let mut seen: HashSet> = HashSet::new(); //! for &f in callbacks { //! if seen.insert(ByAddress(f)) { //! f(); //! } //! } //! } //! ``` //! //! However, note that comparing fat pointers to trait objects can be unreliable because of //! [Rust issue #46139](https://github.com/rust-lang/rust/issues/46139). In some cases, //! [`ByThinAddress`] may be more useful. //! //! 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 // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. #![no_std] use core::cmp::Ordering; use core::convert::AsRef; use core::fmt::{Debug, Display, Formatter}; use core::hash::{Hash, Hasher}; use core::ops::{Deref, DerefMut}; use core::ptr; /// Wrapper for pointer types that implements by-address comparison. /// /// See the [crate-level documentation](index.html) for details. /// /// Equality tests and hashes on fat pointers (`&dyn Trait`, `&[T]`, `&str`, etc) /// include the attribute of the fat pointer. /// /// However, note that comparing fat pointers to trait objects can be unreliable because of /// [Rust issue #46139](https://github.com/rust-lang/rust/issues/46139). In some cases, /// [`ByThinAddress`] may be more useful. #[repr(transparent)] #[derive(Copy, Clone, Default)] pub struct ByAddress(pub T) where T: ?Sized + Deref; impl ByAddress where T: ?Sized + Deref, { /// Convenience method for pointer casts. fn addr(&self) -> *const T::Target { &*self.0 } /// Convert `&T` to `&ByAddress`. pub fn from_ref(r: &T) -> &Self { // SAFETY: `struct ByAddress` is `repr(transparent)`. unsafe { &*(r as *const T as *const Self) } } } struct DebugAdapter<'a, T>(&'a T) where T: ?Sized + Deref + Debug; impl<'a, T> Debug for DebugAdapter<'a, T> where T: ?Sized + Deref + Debug, { fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { self.0.fmt(f)?; f.write_str(" @ ")?; (self.0.deref() as *const T::Target).fmt(f)?; Ok(()) } } impl Debug for ByAddress where T: ?Sized + Deref + Debug, { fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { f.debug_tuple("ByAddress") .field(&DebugAdapter(&self.0)) .finish() } } impl Display for ByAddress where T: ?Sized + Deref + Display, { fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { self.0.fmt(f) } } /// Raw pointer equality impl PartialEq for ByAddress where T: ?Sized + Deref, { fn eq(&self, other: &Self) -> bool { ptr::eq(self.addr(), other.addr()) } } impl Eq for ByAddress where T: ?Sized + Deref {} /// Raw pointer ordering impl Ord for ByAddress where T: ?Sized + Deref, { fn cmp(&self, other: &Self) -> Ordering { self.addr().cmp(&other.addr()) } } /// Raw pointer comparison impl PartialOrd for ByAddress where T: ?Sized + Deref, { fn partial_cmp(&self, other: &Self) -> Option { Some(self.addr().cmp(&other.addr())) } } /// Raw pointer hashing impl Hash for ByAddress where T: ?Sized + Deref, { fn hash(&self, state: &mut H) { self.addr().hash(state) } } // Generic conversion traits: impl Deref for ByAddress where T: ?Sized + Deref, { type Target = T; fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for ByAddress where T: ?Sized + Deref, { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl AsRef for ByAddress where T: ?Sized + Deref + AsRef, { fn as_ref(&self) -> &U { self.0.as_ref() } } impl AsMut for ByAddress where T: ?Sized + Deref + AsMut, { fn as_mut(&mut self) -> &mut U { self.0.as_mut() } } impl From for ByAddress where T: Deref, { fn from(t: T) -> ByAddress { ByAddress(t) } } /// Similar to [`ByAddress`], but omits the attributes of fat pointers. /// /// This means that two slices with the same starting element but different lengths will be /// considered equal. /// /// Two trait objects with the same data pointer but different vtables will also be considered /// equal. (In particular, this may happen for traits that are implemented on zero-sized types, /// including `Fn` and other closure traits.) #[repr(transparent)] #[derive(Copy, Clone, Default)] pub struct ByThinAddress(pub T) where T: ?Sized + Deref; impl ByThinAddress where T: ?Sized + Deref, { /// Convenience method for pointer casts. fn addr(&self) -> *const T::Target { &*self.0 } /// Convert `&T` to `&ByThinAddress`. pub fn from_ref(r: &T) -> &Self { // SAFETY: `struct ByAddress` is `repr(transparent)`. unsafe { &*(r as *const T as *const Self) } } } impl Debug for ByThinAddress where T: ?Sized + Deref + Debug, { fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { f.debug_tuple("ByThinAddress") .field(&DebugAdapter(&self.0)) .finish() } } impl Display for ByThinAddress where T: ?Sized + Deref + Display, { fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result { self.0.fmt(f) } } /// Raw pointer equality impl PartialEq for ByThinAddress where T: ?Sized + Deref, { fn eq(&self, other: &Self) -> bool { core::ptr::eq(self.addr() as *const (), other.addr() as *const _) } } impl Eq for ByThinAddress where T: ?Sized + Deref {} /// Raw pointer ordering impl Ord for ByThinAddress where T: ?Sized + Deref, { fn cmp(&self, other: &Self) -> Ordering { (self.addr() as *const ()).cmp(&(other.addr() as *const ())) } } /// Raw pointer comparison impl PartialOrd for ByThinAddress where T: ?Sized + Deref, { fn partial_cmp(&self, other: &Self) -> Option { Some((self.addr() as *const ()).cmp(&(other.addr() as *const ()))) } } /// Raw pointer hashing impl Hash for ByThinAddress where T: ?Sized + Deref, { fn hash(&self, state: &mut H) { (self.addr() as *const ()).hash(state) } } // Generic conversion traits: impl Deref for ByThinAddress where T: ?Sized + Deref, { type Target = T; fn deref(&self) -> &Self::Target { &self.0 } } impl DerefMut for ByThinAddress where T: ?Sized + Deref, { fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 } } impl AsRef for ByThinAddress where T: ?Sized + Deref + AsRef, { fn as_ref(&self) -> &U { self.0.as_ref() } } #[cfg(test)] mod tests { extern crate std; use std::format; use crate::{ByAddress, ByThinAddress}; trait A: std::fmt::Debug { fn test(&self) {} } trait B: A { fn test2(&self) {} } #[derive(Debug)] struct Test {} impl A for Test {} impl B for Test {} fn force_vtable(v: &O) -> &dyn A { v } #[test] fn test_thin_ptr_fail() { let t = Test {}; let tr1: &dyn A = &t; let tr2: &dyn A = force_vtable(&t); let a = ByAddress(tr1); let b = ByAddress(tr2); assert_ne!(a, b); } #[test] fn test_thin_ptr_success() { let t = Test {}; let tr1: &dyn A = &t; let tr2: &dyn A = force_vtable(&t); let a = ByThinAddress(tr1); let b = ByThinAddress(tr2); assert_eq!(a, b); } #[test] fn test_debug() { let x = &1; let b = ByAddress(x); let expected = format!("ByAddress(1 @ {:p})", x); let actual = format!("{:?}", b); assert_eq!(expected, actual); let t = ByThinAddress(x); let expected = format!("ByThinAddress(1 @ {:p})", x); let actual = format!("{:?}", t); assert_eq!(expected, actual); } }