mercurial-scm/hg: rust/hg-core/src/revlog/node.rs annotate

annotate rust/hg-core/src/revlog/node.rs @ 46128:c94d013e2299

copies-rust: add smarter approach for merging small mapping with large mapping The current approach (finding the smaller updated set) works great when the mapping have similar size, but do a lot of unnecessary work when one side is tinier than the other one. So we do better in theses cases. See inline documentation for details. It give a sizeable boost to many of out slower cases: Repo Case Source-Rev Dest-Rev # of revisions old time new time Difference Factor time per rev --------------------------------------------------------------------------------------------------------------------------------------------------------------- mozilla-try x00000_revs_x_added_0_copies 6a320851d377 1ebb79acd503 : 363753 revs, 18.123103 s, 5.693818 s, -12.429285 s, ? 0.3142, 15 ?s/rev mozilla-try x00000_revs_x_added_x_copies 5173c4b6f97c 95d83ee7242d : 362229 revs, 17.907312 s, 5.677655 s, -12.229657 s, ? 0.3171, 15 ?s/rev mozilla-try x00000_revs_x000_added_x_copies 9126823d0e9c ca82787bb23c : 359344 revs, 17.684797 s, 5.563370 s, -12.121427 s, ? 0.3146, 15 ?s/rev mozilla-try x00000_revs_x0000_added_x0000_copies 8d3fafa80d4b eb884023b810 : 192665 revs, 2.881471 s, 2.864099 s, -0.017372 s, ? 0.9940, 14 ?s/rev mozilla-try x00000_revs_x00000_added_x000_copies 9b2a99adc05e 8e29777b48e6 : 382065 revs, 63.148971 s, 59.498652 s, -3.650319 s, ? 0.9422, 155 ?s/rev mozilla-try x00000_revs_x00000_added_x000_copies 9b2a99adc05e 8e29777b48e6 : 382065 revs, 63.148971 s, 59.498652 s, -3.650319 s, ? 0.9422, 155 ?s/rev ideally, the im-rs object would have a `merge` method, but it does not (yet) Full timing comparison below (they are one pathological case than become even worse, for unclear reason). Repo Case Source-Rev Dest-Rev # of revisions old time new time Difference Factor time per rev --------------------------------------------------------------------------------------------------------------------------------------------------------------- mercurial x_revs_x_added_0_copies ad6b123de1c7 39cfcef4f463 : 1 revs, 0.000043 s, 0.000042 s, -0.000001 s, ? 0.9767, 42 ?s/rev mercurial x_revs_x_added_x_copies 2b1c78674230 0c1d10351869 : 6 revs, 0.000105 s, 0.000104 s, -0.000001 s, ? 0.9905, 17 ?s/rev mercurial x000_revs_x000_added_x_copies 81f8ff2a9bf2 dd3267698d84 : 1032 revs, 0.004895 s, 0.004913 s, +0.000018 s, ? 1.0037, 4 ?s/rev pypy x_revs_x_added_0_copies aed021ee8ae8 099ed31b181b : 9 revs, 0.000194 s, 0.000191 s, -0.000003 s, ? 0.9845, 21 ?s/rev pypy x_revs_x000_added_0_copies 4aa4e1f8e19a 359343b9ac0e : 1 revs, 0.000050 s, 0.000050 s, +0.000000 s, ? 1.0000, 50 ?s/rev pypy x_revs_x_added_x_copies ac52eb7bbbb0 72e022663155 : 7 revs, 0.000115 s, 0.000112 s, -0.000003 s, ? 0.9739, 16 ?s/rev pypy x_revs_x00_added_x_copies c3b14617fbd7 ace7255d9a26 : 1 revs, 0.000289 s, 0.000288 s, -0.000001 s, ? 0.9965, 288 ?s/rev pypy x_revs_x000_added_x000_copies df6f7a526b60 a83dc6a2d56f : 6 revs, 0.010513 s, 0.010411 s, -0.000102 s, ? 0.9903, 1735 ?s/rev pypy x000_revs_xx00_added_0_copies 89a76aede314 2f22446ff07e : 4785 revs, 0.051474 s, 0.052852 s, +0.001378 s, ? 1.0268, 11 ?s/rev pypy x000_revs_x000_added_x_copies 8a3b5bfd266e 2c68e87c3efe : 6780 revs, 0.088086 s, 0.092828 s, +0.004742 s, ? 1.0538, 13 ?s/rev pypy x000_revs_x000_added_x000_copies 89a76aede314 7b3dda341c84 : 5441 revs, 0.062176 s, 0.063269 s, +0.001093 s, ? 1.0176, 11 ?s/rev pypy x0000_revs_x_added_0_copies d1defd0dc478 c9cb1334cc78 : 43645 revs, 0.720950 s, 0.711975 s, -0.008975 s, ? 0.9876, 16 ?s/rev pypy x0000_revs_xx000_added_0_copies bf2c629d0071 4ffed77c095c : 2 revs, 0.012897 s, 0.012771 s, -0.000126 s, ? 0.9902, 6385 ?s/rev pypy x0000_revs_xx000_added_x000_copies 08ea3258278e d9fa043f30c0 : 11316 revs, 0.121524 s, 0.124505 s, +0.002981 s, ? 1.0245, 11 ?s/rev netbeans x_revs_x_added_0_copies fb0955ffcbcd a01e9239f9e7 : 2 revs, 0.000082 s, 0.000082 s, +0.000000 s, ? 1.0000, 41 ?s/rev netbeans x_revs_x000_added_0_copies 6f360122949f 20eb231cc7d0 : 2 revs, 0.000109 s, 0.000111 s, +0.000002 s, ? 1.0183, 55 ?s/rev netbeans x_revs_x_added_x_copies 1ada3faf6fb6 5a39d12eecf4 : 3 revs, 0.000175 s, 0.000171 s, -0.000004 s, ? 0.9771, 57 ?s/rev netbeans x_revs_x00_added_x_copies 35be93ba1e2c 9eec5e90c05f : 9 revs, 0.000719 s, 0.000708 s, -0.000011 s, ? 0.9847, 78 ?s/rev netbeans x000_revs_xx00_added_0_copies eac3045b4fdd 51d4ae7f1290 : 1421 revs, 0.010426 s, 0.010608 s, +0.000182 s, ? 1.0175, 7 ?s/rev netbeans x000_revs_x000_added_x_copies e2063d266acd 6081d72689dc : 1533 revs, 0.015712 s, 0.015635 s, -0.000077 s, ? 0.9951, 10 ?s/rev netbeans x000_revs_x000_added_x000_copies ff453e9fee32 411350406ec2 : 5750 revs, 0.077353 s, 0.072072 s, -0.005281 s, ? 0.9317, 12 ?s/rev netbeans x0000_revs_xx000_added_x000_copies 588c2d1ced70 1aad62e59ddd : 66949 revs, 0.673930 s, 0.682732 s, +0.008802 s, ? 1.0131, 10 ?s/rev mozilla-central x_revs_x_added_0_copies 3697f962bb7b 7015fcdd43a2 : 2 revs, 0.000089 s, 0.000090 s, +0.000001 s, ? 1.0112, 45 ?s/rev mozilla-central x_revs_x000_added_0_copies dd390860c6c9 40d0c5bed75d : 8 revs, 0.000212 s, 0.000210 s, -0.000002 s, ? 0.9906, 26 ?s/rev mozilla-central x_revs_x_added_x_copies 8d198483ae3b 14207ffc2b2f : 9 revs, 0.000183 s, 0.000182 s, -0.000001 s, ? 0.9945, 20 ?s/rev mozilla-central x_revs_x00_added_x_copies 98cbc58cc6bc 446a150332c3 : 7 revs, 0.000595 s, 0.000594 s, -0.000001 s, ? 0.9983, 84 ?s/rev mozilla-central x_revs_x000_added_x000_copies 3c684b4b8f68 0a5e72d1b479 : 3 revs, 0.003117 s, 0.003102 s, -0.000015 s, ? 0.9952, 1034 ?s/rev mozilla-central x_revs_x0000_added_x0000_copies effb563bb7e5 c07a39dc4e80 : 6 revs, 0.060197 s, 0.060234 s, +0.000037 s, ? 1.0006, 10039 ?s/rev mozilla-central x000_revs_xx00_added_0_copies 6100d773079a 04a55431795e : 1593 revs, 0.006379 s, 0.006300 s, -0.000079 s, ? 0.9876, 3 ?s/rev mozilla-central x000_revs_x000_added_x_copies 9f17a6fc04f9 2d37b966abed : 41 revs, 0.005008 s, 0.004817 s, -0.000191 s, ? 0.9619, 117 ?s/rev mozilla-central x000_revs_x000_added_x000_copies 7c97034feb78 4407bd0c6330 : 7839 revs, 0.065123 s, 0.065451 s, +0.000328 s, ? 1.0050, 8 ?s/rev mozilla-central x0000_revs_xx000_added_0_copies 9eec5917337d 67118cc6dcad : 615 revs, 0.026404 s, 0.026282 s, -0.000122 s, ? 0.9954, 42 ?s/rev mozilla-central x0000_revs_xx000_added_x000_copies f78c615a656c 96a38b690156 : 30263 revs, 0.203456 s, 0.206873 s, +0.003417 s, ? 1.0168, 6 ?s/rev mozilla-central x00000_revs_x0000_added_x0000_copies 6832ae71433c 4c222a1d9a00 : 153721 revs, 1.929809 s, 1.935918 s, +0.006109 s, ? 1.0032, 12 ?s/rev mozilla-central x00000_revs_x00000_added_x000_copies 76caed42cf7c 1daa622bbe42 : 204976 revs, 2.825064 s, 2.827320 s, +0.002256 s, ? 1.0008, 13 ?s/rev mozilla-try x_revs_x_added_0_copies aaf6dde0deb8 9790f499805a : 2 revs, 0.000857 s, 0.000842 s, -0.000015 s, ? 0.9825, 421 ?s/rev mozilla-try x_revs_x000_added_0_copies d8d0222927b4 5bb8ce8c7450 : 2 revs, 0.000870 s, 0.000870 s, +0.000000 s, ? 1.0000, 435 ?s/rev mozilla-try x_revs_x_added_x_copies 092fcca11bdb 936255a0384a : 4 revs, 0.000161 s, 0.000165 s, +0.000004 s, ? 1.0248, 41 ?s/rev mozilla-try x_revs_x00_added_x_copies b53d2fadbdb5 017afae788ec : 2 revs, 0.001147 s, 0.001145 s, -0.000002 s, ? 0.9983, 572 ?s/rev mozilla-try x_revs_x000_added_x000_copies 20408ad61ce5 6f0ee96e21ad : 1 revs, 0.026640 s, 0.026500 s, -0.000140 s, ? 0.9947, 26500 ?s/rev mozilla-try x_revs_x0000_added_x0000_copies effb563bb7e5 c07a39dc4e80 : 6 revs, 0.059849 s, 0.059407 s, -0.000442 s, ? 0.9926, 9901 ?s/rev mozilla-try x000_revs_xx00_added_0_copies 6100d773079a 04a55431795e : 1593 revs, 0.006326 s, 0.006325 s, -0.000001 s, ? 0.9998, 3 ?s/rev mozilla-try x000_revs_x000_added_x_copies 9f17a6fc04f9 2d37b966abed : 41 revs, 0.005188 s, 0.005171 s, -0.000017 s, ? 0.9967, 126 ?s/rev mozilla-try x000_revs_x000_added_x000_copies 1346fd0130e4 4c65cbdabc1f : 6657 revs, 0.067633 s, 0.066837 s, -0.000796 s, ? 0.9882, 10 ?s/rev mozilla-try x0000_revs_x_added_0_copies 63519bfd42ee a36a2a865d92 : 40314 revs, 0.306969 s, 0.314252 s, +0.007283 s, ? 1.0237, 7 ?s/rev mozilla-try x0000_revs_x_added_x_copies 9fe69ff0762d bcabf2a78927 : 38690 revs, 0.293370 s, 0.304160 s, +0.010790 s, ? 1.0368, 7 ?s/rev mozilla-try x0000_revs_xx000_added_x_copies 156f6e2674f2 4d0f2c178e66 : 8598 revs, 0.087159 s, 0.089223 s, +0.002064 s, ? 1.0237, 10 ?s/rev mozilla-try x0000_revs_xx000_added_0_copies 9eec5917337d 67118cc6dcad : 615 revs, 0.027251 s, 0.026711 s, -0.000540 s, ? 0.9802, 43 ?s/rev mozilla-try x0000_revs_xx000_added_x000_copies 89294cd501d9 7ccb2fc7ccb5 : 97052 revs, 3.010011 s, 3.243010 s, +0.232999 s, ? 1.0774, 33 ?s/rev mozilla-try x0000_revs_x0000_added_x0000_copies e928c65095ed e951f4ad123a : 52031 revs, 0.753434 s, 0.756500 s, +0.003066 s, ? 1.0041, 14 ?s/rev mozilla-try x00000_revs_x_added_0_copies 6a320851d377 1ebb79acd503 : 363753 revs, 18.123103 s, 5.693818 s, -12.429285 s, ? 0.3142, 15 ?s/rev mozilla-try x00000_revs_x00000_added_0_copies dc8a3ca7010e d16fde900c9c : 34414 revs, 0.583206 s, 0.590904 s, +0.007698 s, ? 1.0132, 17 ?s/rev mozilla-try x00000_revs_x_added_x_copies 5173c4b6f97c 95d83ee7242d : 362229 revs, 17.907312 s, 5.677655 s, -12.229657 s, ? 0.3171, 15 ?s/rev mozilla-try x00000_revs_x000_added_x_copies 9126823d0e9c ca82787bb23c : 359344 revs, 17.684797 s, 5.563370 s, -12.121427 s, ? 0.3146, 15 ?s/rev mozilla-try x00000_revs_x0000_added_x0000_copies 8d3fafa80d4b eb884023b810 : 192665 revs, 2.881471 s, 2.864099 s, -0.017372 s, ? 0.9940, 14 ?s/rev mozilla-try x00000_revs_x00000_added_x0000_copies 1b661134e2ca 1ae03d022d6d : 228985 revs, 101.062002 s, 113.297287 s, +12.235285 s, ? 1.1211, 494 ?s/rev mozilla-try x00000_revs_x00000_added_x000_copies 9b2a99adc05e 8e29777b48e6 : 382065 revs, 63.148971 s, 59.498652 s, -3.650319 s, ? 0.9422, 155 ?s/rev Differential Revision: https://phab.mercurial-scm.org/D9491

author	Pierre-Yves David <pierre-yves.david@octobus.net>
date	Sat, 21 Nov 2020 09:40:52 +0100
parents	88e741bf2d93
children	cfb6c10c08c2

rev	line source
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	1 // Copyright 2019-2020 Georges Racinet <georges.racinet@octobus.net>
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	2 //
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	3 // This software may be used and distributed according to the terms of the
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	4 // GNU General Public License version 2 or any later version.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	5
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	6 //! Definitions and utilities for Revision nodes
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	7 //!
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	8 //! In Mercurial code base, it is customary to call "a node" the binary SHA
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	9 //! of a revision.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	10
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	11 use hex::{self, FromHex, FromHexError};
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	12 use std::convert::{TryFrom, TryInto};
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	13
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	14 /// The length in bytes of a `Node`
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	15 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	16 /// This constant is meant to ease refactors of this module, and
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	17 /// are private so that calling code does not expect all nodes have
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	18 /// the same size, should we support several formats concurrently in
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	19 /// the future.
45531 b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	20 pub const NODE_BYTES_LENGTH: usize = 20;
b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	21
b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	22 /// Id of the null node.
b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	23 ///
b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	24 /// Used to indicate the absence of node.
b0d6309ff50c hg-core: check data integrity in `Revlog` Antoine Cezar <antoine.cezar@octobus.net> parents: 44973 diff changeset	25 pub const NULL_NODE_ID: [u8; NODE_BYTES_LENGTH] = [0u8; NODE_BYTES_LENGTH];
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	26
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	27 /// The length in bytes of a `Node`
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	28 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	29 /// see also `NODES_BYTES_LENGTH` about it being private.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	30 const NODE_NYBBLES_LENGTH: usize = 2 * NODE_BYTES_LENGTH;
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	31
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	32 /// Private alias for readability and to ease future change
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	33 type NodeData = [u8; NODE_BYTES_LENGTH];
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	34
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	35 /// Binary revision SHA
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	36 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	37 /// ## Future changes of hash size
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	38 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	39 /// To accomodate future changes of hash size, Rust callers
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	40 /// should use the conversion methods at the boundaries (FFI, actual
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	41 /// computation of hashes and I/O) only, and only if required.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	42 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	43 /// All other callers outside of unit tests should just handle `Node` values
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	44 /// and never make any assumption on the actual length, using [`nybbles_len`]
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	45 /// if they need a loop boundary.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	46 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	47 /// All methods that create a `Node` either take a type that enforces
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	48 /// the size or fail immediately at runtime with [`ExactLengthRequired`].
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	49 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	50 /// [`nybbles_len`]: #method.nybbles_len
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	51 /// [`ExactLengthRequired`]: struct.NodeError#variant.ExactLengthRequired
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	52 #[derive(Clone, Debug, PartialEq)]
44502 166349510398 revlog: using two new functions in C capsule from Rust code Georges Racinet <georges.racinet@octobus.net> parents: 44388 diff changeset	53 #[repr(transparent)]
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	54 pub struct Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	55 data: NodeData,
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	56 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	57
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	58 /// The node value for NULL_REVISION
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	59 pub const NULL_NODE: Node = Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	60 data: [0; NODE_BYTES_LENGTH],
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	61 };
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	62
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	63 impl From<NodeData> for Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	64 fn from(data: NodeData) -> Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	65 Node { data }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	66 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	67 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	68
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	69 /// Return an error if the slice has an unexpected length
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	70 impl<'a> TryFrom<&'a [u8]> for &'a Node {
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	71 type Error = std::array::TryFromSliceError;
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	72
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	73 #[inline]
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	74 fn try_from(bytes: &'a [u8]) -> Result<&'a Node, Self::Error> {
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	75 let data = bytes.try_into()?;
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	76 // Safety: `#[repr(transparent)]` makes it ok to "wrap" the target
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	77 // of a reference to the type of the single field.
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	78 Ok(unsafe { std::mem::transmute::<&NodeData, &Node>(data) })
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	79 }
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	80 }
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	81
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	82 #[derive(Debug, PartialEq)]
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	83 pub enum NodeError {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	84 ExactLengthRequired(usize, String),
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	85 PrefixTooLong(String),
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	86 HexError(FromHexError, String),
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	87 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	88
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	89 /// Low level utility function, also for prefixes
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	90 fn get_nybble(s: &[u8], i: usize) -> u8 {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	91 if i % 2 == 0 {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	92 s[i / 2] >> 4
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	93 } else {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	94 s[i / 2] & 0x0f
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	95 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	96 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	97
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	98 impl Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	99 /// Retrieve the `i`th half-byte of the binary data.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	100 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	101 /// This is also the `i`th hexadecimal digit in numeric form,
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	102 /// also called a [nybble](https://en.wikipedia.org/wiki/Nibble).
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	103 pub fn get_nybble(&self, i: usize) -> u8 {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	104 get_nybble(&self.data, i)
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	105 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	106
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	107 /// Length of the data, in nybbles
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	108 pub fn nybbles_len(&self) -> usize {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	109 // public exposure as an instance method only, so that we can
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	110 // easily support several sizes of hashes if needed in the future.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	111 NODE_NYBBLES_LENGTH
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	112 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	113
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	114 /// Convert from hexadecimal string representation
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	115 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	116 /// Exact length is required.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	117 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	118 /// To be used in FFI and I/O only, in order to facilitate future
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	119 /// changes of hash format.
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	120 pub fn from_hex(hex: impl AsRef<[u8]>) -> Result<Node, NodeError> {
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	121 Ok(NodeData::from_hex(hex.as_ref())
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	122 .map_err(\|e\| NodeError::from((e, hex)))?
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	123 .into())
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	124 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	125
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	126 /// Convert to hexadecimal string representation
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	127 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	128 /// To be used in FFI and I/O only, in order to facilitate future
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	129 /// changes of hash format.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	130 pub fn encode_hex(&self) -> String {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	131 hex::encode(self.data)
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	132 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	133
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	134 /// Provide access to binary data
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	135 ///
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	136 /// This is needed by FFI layers, for instance to return expected
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	137 /// binary values to Python.
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	138 pub fn as_bytes(&self) -> &[u8] {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	139 &self.data
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	140 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	141 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	142
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	143 impl<T: AsRef<[u8]>> From<(FromHexError, T)> for NodeError {
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	144 fn from(err_offender: (FromHexError, T)) -> Self {
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	145 let (err, offender) = err_offender;
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	146 let offender = String::from_utf8_lossy(offender.as_ref()).into_owned();
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	147 match err {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	148 FromHexError::InvalidStringLength => {
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	149 NodeError::ExactLengthRequired(NODE_NYBBLES_LENGTH, offender)
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	150 }
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	151 _ => NodeError::HexError(err, offender),
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	152 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	153 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	154 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	155
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	156 /// The beginning of a binary revision SHA.
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	157 ///
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	158 /// Since it can potentially come from an hexadecimal representation with
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	159 /// odd length, it needs to carry around whether the last 4 bits are relevant
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	160 /// or not.
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	161 #[derive(Debug, PartialEq)]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	162 pub struct NodePrefix {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	163 buf: Vec<u8>,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	164 is_odd: bool,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	165 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	166
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	167 impl NodePrefix {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	168 /// Convert from hexadecimal string representation
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	169 ///
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	170 /// Similarly to `hex::decode`, can be used with Unicode string types
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	171 /// (`String`, `&str`) as well as bytes.
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	172 ///
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	173 /// To be used in FFI and I/O only, in order to facilitate future
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	174 /// changes of hash format.
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	175 pub fn from_hex(hex: impl AsRef<[u8]>) -> Result<Self, NodeError> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	176 let hex = hex.as_ref();
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	177 let len = hex.len();
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	178 if len > NODE_NYBBLES_LENGTH {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	179 return Err(NodeError::PrefixTooLong(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	180 String::from_utf8_lossy(hex).to_owned().to_string(),
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	181 ));
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	182 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	183
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	184 let is_odd = len % 2 == 1;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	185 let even_part = if is_odd { &hex[..len - 1] } else { hex };
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	186 let mut buf: Vec<u8> =
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	187 Vec::from_hex(&even_part).map_err(\|e\| (e, hex))?;
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	188
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	189 if is_odd {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	190 let latest_char = char::from(hex[len - 1]);
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	191 let latest_nybble = latest_char.to_digit(16).ok_or_else(\|\| {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	192 (
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	193 FromHexError::InvalidHexCharacter {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	194 c: latest_char,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	195 index: len - 1,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	196 },
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	197 hex,
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	198 )
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	199 })? as u8;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	200 buf.push(latest_nybble << 4);
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	201 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	202 Ok(NodePrefix { buf, is_odd })
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	203 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	204
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	205 pub fn borrow(&self) -> NodePrefixRef {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	206 NodePrefixRef {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	207 buf: &self.buf,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	208 is_odd: self.is_odd,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	209 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	210 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	211 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	212
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	213 #[derive(Clone, Debug, PartialEq)]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	214 pub struct NodePrefixRef<'a> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	215 buf: &'a [u8],
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	216 is_odd: bool,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	217 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	218
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	219 impl<'a> NodePrefixRef<'a> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	220 pub fn len(&self) -> usize {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	221 if self.is_odd {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	222 self.buf.len() * 2 - 1
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	223 } else {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	224 self.buf.len() * 2
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	225 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	226 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	227
44973 26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	228 pub fn is_empty(&self) -> bool {
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	229 self.len() == 0
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	230 }
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	231
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	232 pub fn is_prefix_of(&self, node: &Node) -> bool {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	233 if self.is_odd {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	234 let buf = self.buf;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	235 let last_pos = buf.len() - 1;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	236 node.data.starts_with(buf.split_at(last_pos).0)
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	237 && node.data[last_pos] >> 4 == buf[last_pos] >> 4
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	238 } else {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	239 node.data.starts_with(self.buf)
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	240 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	241 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	242
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	243 /// Retrieve the `i`th half-byte from the prefix.
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	244 ///
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	245 /// This is also the `i`th hexadecimal digit in numeric form,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	246 /// also called a [nybble](https://en.wikipedia.org/wiki/Nibble).
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	247 pub fn get_nybble(&self, i: usize) -> u8 {
44187 be52b7372ec2 rust-node: avoid meaningless read at the end of odd prefix Georges Racinet <georges.racinet@octobus.net> parents: 44183 diff changeset	248 assert!(i < self.len());
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	249 get_nybble(self.buf, i)
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	250 }
44388 5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	251
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	252 /// Return the index first nybble that's different from `node`
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	253 ///
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	254 /// If the return value is `None` that means that `self` is
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	255 /// a prefix of `node`, but the current method is a bit slower
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	256 /// than `is_prefix_of`.
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	257 ///
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	258 /// Returned index is as in `get_nybble`, i.e., starting at 0.
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	259 pub fn first_different_nybble(&self, node: &Node) -> Option<usize> {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	260 let buf = self.buf;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	261 let until = if self.is_odd {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	262 buf.len() - 1
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	263 } else {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	264 buf.len()
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	265 };
44973 26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	266 for (i, item) in buf.iter().enumerate().take(until) {
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	267 if *item != node.data[i] {
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	268 return if *item & 0xf0 == node.data[i] & 0xf0 {
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	269 Some(2 * i + 1)
44388 5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	270 } else {
44973 26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	271 Some(2 * i)
26114bd6ec60 rust: do a clippy pass Rapha?l Gom?s <rgomes@octobus.net> parents: 44502 diff changeset	272 };
44388 5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	273 }
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	274 }
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	275 if self.is_odd && buf[until] & 0xf0 != node.data[until] & 0xf0 {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	276 Some(until * 2)
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	277 } else {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	278 None
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	279 }
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	280 }
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	281 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	282
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	283 /// A shortcut for full `Node` references
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	284 impl<'a> From<&'a Node> for NodePrefixRef<'a> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	285 fn from(node: &'a Node) -> Self {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	286 NodePrefixRef {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	287 buf: &node.data,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	288 is_odd: false,
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	289 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	290 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	291 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	292
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	293 impl PartialEq<Node> for NodePrefixRef<'_> {
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	294 fn eq(&self, other: &Node) -> bool {
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	295 !self.is_odd && self.buf == other.data
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	296 }
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	297 }
88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	298
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	299 #[cfg(test)]
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	300 mod tests {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	301 use super::*;
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	302
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	303 fn sample_node() -> Node {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	304 let mut data = [0; NODE_BYTES_LENGTH];
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	305 data.copy_from_slice(&[
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	306 0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0xfe, 0xdc, 0xba,
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	307 0x98, 0x76, 0x54, 0x32, 0x10, 0xde, 0xad, 0xbe, 0xef,
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	308 ]);
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	309 data.into()
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	310 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	311
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	312 /// Pad an hexadecimal string to reach `NODE_NYBBLES_LENGTH`
46033 88e741bf2d93 rust: use NodePrefix::from_hex instead of hex::decode directly Simon Sapin <simon-commits@exyr.org> parents: 45531 diff changeset	313 ///check_hash
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	314 /// The padding is made with zeros
44183 e52401a95b94 rust-nodemap: NodeMap trait with simplest implementation Georges Racinet <georges.racinet@octobus.net> parents: 44182 diff changeset	315 pub fn hex_pad_right(hex: &str) -> String {
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	316 let mut res = hex.to_string();
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	317 while res.len() < NODE_NYBBLES_LENGTH {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	318 res.push('0');
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	319 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	320 res
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	321 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	322
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	323 fn sample_node_hex() -> String {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	324 hex_pad_right("0123456789abcdeffedcba9876543210deadbeef")
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	325 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	326
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	327 #[test]
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	328 fn test_node_from_hex() {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	329 assert_eq!(Node::from_hex(&sample_node_hex()), Ok(sample_node()));
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	330
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	331 let mut short = hex_pad_right("0123");
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	332 short.pop();
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	333 short.pop();
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	334 assert_eq!(
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	335 Node::from_hex(&short),
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	336 Err(NodeError::ExactLengthRequired(NODE_NYBBLES_LENGTH, short)),
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	337 );
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	338
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	339 let not_hex = hex_pad_right("012... oops");
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	340 assert_eq!(
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	341 Node::from_hex(&not_hex),
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	342 Err(NodeError::HexError(
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	343 FromHexError::InvalidHexCharacter { c: '.', index: 3 },
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	344 not_hex,
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	345 )),
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	346 );
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	347 }
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	348
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	349 #[test]
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	350 fn test_node_encode_hex() {
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	351 assert_eq!(sample_node().encode_hex(), sample_node_hex());
7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	352 }
44182 9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	353
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	354 #[test]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	355 fn test_prefix_from_hex() -> Result<(), NodeError> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	356 assert_eq!(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	357 NodePrefix::from_hex("0e1")?,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	358 NodePrefix {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	359 buf: vec![14, 16],
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	360 is_odd: true
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	361 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	362 );
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	363 assert_eq!(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	364 NodePrefix::from_hex("0e1a")?,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	365 NodePrefix {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	366 buf: vec![14, 26],
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	367 is_odd: false
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	368 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	369 );
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	370
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	371 // checking limit case
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	372 let node_as_vec = sample_node().data.iter().cloned().collect();
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	373 assert_eq!(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	374 NodePrefix::from_hex(sample_node_hex())?,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	375 NodePrefix {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	376 buf: node_as_vec,
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	377 is_odd: false
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	378 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	379 );
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	380
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	381 Ok(())
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	382 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	383
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	384 #[test]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	385 fn test_prefix_from_hex_errors() {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	386 assert_eq!(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	387 NodePrefix::from_hex("testgr"),
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	388 Err(NodeError::HexError(
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	389 FromHexError::InvalidHexCharacter { c: 't', index: 0 },
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	390 "testgr".to_string()
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	391 ))
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	392 );
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	393 let mut long = NULL_NODE.encode_hex();
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	394 long.push('c');
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	395 match NodePrefix::from_hex(&long)
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	396 .expect_err("should be refused as too long")
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	397 {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	398 NodeError::PrefixTooLong(s) => assert_eq!(s, long),
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	399 err => panic!(format!("Should have been TooLong, got {:?}", err)),
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	400 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	401 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	402
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	403 #[test]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	404 fn test_is_prefix_of() -> Result<(), NodeError> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	405 let mut node_data = [0; NODE_BYTES_LENGTH];
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	406 node_data[0] = 0x12;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	407 node_data[1] = 0xca;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	408 let node = Node::from(node_data);
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	409 assert!(NodePrefix::from_hex("12")?.borrow().is_prefix_of(&node));
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	410 assert!(!NodePrefix::from_hex("1a")?.borrow().is_prefix_of(&node));
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	411 assert!(NodePrefix::from_hex("12c")?.borrow().is_prefix_of(&node));
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	412 assert!(!NodePrefix::from_hex("12d")?.borrow().is_prefix_of(&node));
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	413 Ok(())
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	414 }
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	415
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	416 #[test]
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	417 fn test_get_nybble() -> Result<(), NodeError> {
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	418 let prefix = NodePrefix::from_hex("dead6789cafe")?;
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	419 assert_eq!(prefix.borrow().get_nybble(0), 13);
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	420 assert_eq!(prefix.borrow().get_nybble(7), 9);
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	421 Ok(())
9896a8d0d3d2 rust-node: handling binary Node prefix Georges Racinet <georges.racinet@octobus.net> parents: 44143 diff changeset	422 }
44388 5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	423
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	424 #[test]
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	425 fn test_first_different_nybble_even_prefix() {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	426 let prefix = NodePrefix::from_hex("12ca").unwrap();
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	427 let prefref = prefix.borrow();
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	428 let mut node = Node::from([0; NODE_BYTES_LENGTH]);
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	429 assert_eq!(prefref.first_different_nybble(&node), Some(0));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	430 node.data[0] = 0x13;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	431 assert_eq!(prefref.first_different_nybble(&node), Some(1));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	432 node.data[0] = 0x12;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	433 assert_eq!(prefref.first_different_nybble(&node), Some(2));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	434 node.data[1] = 0xca;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	435 // now it is a prefix
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	436 assert_eq!(prefref.first_different_nybble(&node), None);
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	437 }
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	438
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	439 #[test]
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	440 fn test_first_different_nybble_odd_prefix() {
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	441 let prefix = NodePrefix::from_hex("12c").unwrap();
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	442 let prefref = prefix.borrow();
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	443 let mut node = Node::from([0; NODE_BYTES_LENGTH]);
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	444 assert_eq!(prefref.first_different_nybble(&node), Some(0));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	445 node.data[0] = 0x13;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	446 assert_eq!(prefref.first_different_nybble(&node), Some(1));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	447 node.data[0] = 0x12;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	448 assert_eq!(prefref.first_different_nybble(&node), Some(2));
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	449 node.data[1] = 0xca;
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	450 // now it is a prefix
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	451 assert_eq!(prefref.first_different_nybble(&node), None);
5ac1eecc9c64 rust-nodemap: core implementation for shortest Georges Racinet <georges.racinet@octobus.net> parents: 44187 diff changeset	452 }
44143 7f86426fdd2c rust-node: binary Node ID and conversion utilities Georges Racinet <georges.racinet@octobus.net> parents: diff changeset	453 }
44183 e52401a95b94 rust-nodemap: NodeMap trait with simplest implementation Georges Racinet <georges.racinet@octobus.net> parents: 44182 diff changeset	454
e52401a95b94 rust-nodemap: NodeMap trait with simplest implementation Georges Racinet <georges.racinet@octobus.net> parents: 44182 diff changeset	455 #[cfg(test)]
e52401a95b94 rust-nodemap: NodeMap trait with simplest implementation Georges Racinet <georges.racinet@octobus.net> parents: 44182 diff changeset	456 pub use tests::hex_pad_right;

Mercurial > public > mercurial-scm > hg

annotate rust/hg-core/src/revlog/node.rs @ 46128:c94d013e2299