From 55e9af776b4373da72df57422290d954afb6ad8d Mon Sep 17 00:00:00 2001 From: Andreas Fackler Date: Thu, 11 Oct 2018 14:23:53 +0200 Subject: [PATCH] Initial commit --- .gitignore | 3 + .travis.yml | 22 ++++++ COPYRIGHT | 7 ++ Cargo.toml | 12 +++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 21 ++++++ README.md | 16 ++++ src/lib.rs | 114 ++++++++++++++++++++++++++++ 8 files changed, 396 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 COPYRIGHT create mode 100644 Cargo.toml create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 README.md create mode 100644 src/lib.rs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6936990 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/target +**/*.rs.bk +Cargo.lock diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..0140539 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,22 @@ +language: rust +rust: + - 1.29.1 +cache: + cargo: true + timeout: 1200 +addons: + apt: + packages: + - unzip +before_install: + - rustup component add --toolchain=${TRAVIS_RUST_VERSION} rustfmt-preview clippy-preview + - cargo deadlinks --version || cargo install cargo-deadlinks +env: + global: + - RUST_BACKTRACE=1 +script: + - cargo clippy --all-targets -- --deny clippy + - cargo fmt -- --check + - cargo test + - cargo doc + - cargo deadlinks --dir target/doc/threshold_crypto/ diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000..9fdef9a --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,7 @@ +hex_fmt is copyright 2018, POA Networks, Ltd. + +Licensed under the Apache License, Version 2.0 or the MIT license , at your option. All files in the project +carrying such notice may not be copied, modified, or distributed except +according to those terms. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..bf496c6 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,12 @@ +[package] +name = "hex_fmt" +description = "Formatting and shortening byte slices as hexadecimal strings" +version = "0.1.0" +license = "MIT/Apache-2.0" +authors = ["Andreas Fackler "] +repository = "https://github.com/poanetwork/hex_fmt" +readme = "README.md" +keywords = ["format", "hex", "display", "debug"] +categories = ["value-formatting", "debugging"] + +[dependencies] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..f8e5e5e --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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. \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..be6210c --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License + +Copyright (c) 2018, POA Networks, Ltd. + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..46b5c5c --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Formatting and shortening byte slices as hexadecimal strings + +This crate provides wrappers for byte slices and lists of byte slices that implement the +standard formatting traits and print the bytes as a hexadecimal string, eliding from the middle +if the length would exceed the `precision` format parameter. + +```rust +use hex_fmt::{HexFmt, HexList}; + +assert_eq!("090a0b", &format!("{}", HexFmt(&[9u8, 10, 11]))); +let nine_to_f = [9u8, 10, 11, 12, 13, 14, 15]; +assert_eq!("090..0f", &format!("{:.7}", HexFmt(&nine_to_f))); +assert_eq!("090..e0f", &format!("{:.8}", HexFmt(&nine_to_f))); +assert_eq!("090a..0e0f", &format!("{}", HexFmt(&nine_to_f))); +assert_eq!("[4142, 4241]", &format!("{}", HexList(&[b"AB", b"BA"]))); +``` diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..28bc776 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,114 @@ +//! # Formatting and shortening byte slices as hexadecimal strings +//! +//! This crate provides wrappers for byte slices and lists of byte slices that implement the +//! standard formatting traits and print the bytes as a hexadecimal string, eliding from the middle +//! if the length would exceed the `precision` format parameter. +//! +//! ``` +//! use hex_fmt::{HexFmt, HexList}; +//! +//! assert_eq!("090a0b", &format!("{}", HexFmt(&[9u8, 10, 11]))); +//! let nine_to_f = [9u8, 10, 11, 12, 13, 14, 15]; +//! assert_eq!("090..0f", &format!("{:.7}", HexFmt(&nine_to_f))); +//! assert_eq!("090..e0f", &format!("{:.8}", HexFmt(&nine_to_f))); +//! assert_eq!("090a..0e0f", &format!("{}", HexFmt(&nine_to_f))); +//! assert_eq!("[4142, 4241]", &format!("{}", HexList(&[b"AB", b"BA"]))); +//! ``` + +use std::fmt::{Debug, Display, Formatter, LowerHex, Result}; + +const DEFAULT_PRECISION: usize = 10; +const ELLIPSIS: &str = ".."; + +// TODO: Implement `UpperHex`. + +/// Wrapper for a byte array, whose `Debug`, `Display` and `LowerHex` implementations output +/// shortened hexadecimal strings. +pub struct HexFmt(pub T); + +impl> Debug for HexFmt { + fn fmt(&self, f: &mut Formatter) -> Result { + LowerHex::fmt(self, f) + } +} + +impl> Display for HexFmt { + fn fmt(&self, f: &mut Formatter) -> Result { + LowerHex::fmt(self, f) + } +} + +impl> LowerHex for HexFmt { + fn fmt(&self, f: &mut Formatter) -> Result { + let precision = f.precision().unwrap_or(DEFAULT_PRECISION); + let bytes = self.0.as_ref(); + // TODO: Respect `f.width()`, `f.align()` and `f.fill()`. + + // If the array is short enough, don't shorten it. + if 2 * bytes.len() <= precision { + for byte in bytes { + write!(f, "{:02x}", byte)?; + } + return Ok(()); + } + + // Compute the number of hex digits to display left and right of the ellipsis. + let num_hex_digits = precision.saturating_sub(ELLIPSIS.len()); + let right = num_hex_digits / 2; + let left = num_hex_digits - right; + + // Print the bytes on the left. + for byte in &bytes[..(left / 2)] { + write!(f, "{:02x}", byte)?; + } + // If odd, print only the first hex digit of the next byte. + if left & 1 == 1 { + write!(f, "{:1x}", bytes[left / 2] >> 4)?; + } + + // Print the ellipsis. + f.write_str(ELLIPSIS)?; + + // If `right` is odd, print the second hex digit of a byte. + if right & 1 == 1 { + write!(f, "{:1x}", bytes[(bytes.len() - right / 2 - 1)] & 0x0f)?; + } + // Print the remaining bytes on the right. + for byte in &bytes[(bytes.len() - right / 2)..] { + write!(f, "{:02x}", byte)?; + } + Ok(()) + } +} + +/// Wrapper for a list of byte arrays, whose `Debug`, `Display` and `LowerHex` implementations +/// output shortened hexadecimal strings. +pub struct HexList(pub T); + +impl Debug for HexList +where + T::Item: AsRef<[u8]>, +{ + fn fmt(&self, f: &mut Formatter) -> Result { + LowerHex::fmt(self, f) + } +} + +impl Display for HexList +where + T::Item: AsRef<[u8]>, +{ + fn fmt(&self, f: &mut Formatter) -> Result { + LowerHex::fmt(self, f) + } +} + +impl LowerHex for HexList +where + T::Item: AsRef<[u8]>, +{ + fn fmt(&self, f: &mut Formatter) -> Result { + let entries = self.0.clone().into_iter().map(HexFmt); + f.debug_list().entries(entries).finish() + } +}