From dc30d6090df0d10c645e82d1a28c8ac6fd2df5cc Mon Sep 17 00:00:00 2001 From: Nicolas Stalder Date: Fri, 17 Jan 2020 14:20:37 +0100 Subject: [PATCH] Initial commit --- .gitignore | 3 + Cargo.toml | 27 +++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++ LICENSE-MIT | 25 ++++ README.md | 17 +++ src/lib.rs | 312 +++++++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 585 insertions(+) create mode 100644 .gitignore 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/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..39172d7 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,27 @@ +[package] +name = "heapless-bytes" +version = "0.1.0-unreleased" +authors = ["Nicolas Stalder "] +license = "Apache-2.0 OR MIT" +description = "Newtype around heapless byte Vec with efficient serde." +categories = ["embedded", "encoding", "no-std"] +keywords = ["serde", "cbor", "rust", "no-std"] +repository = "https://github.com/ycrypto/heapless-bytes" +readme = "README.md" +edition = "2018" + +[dependencies.heapless] +version = "0.5.1" +default-features = false + +[dependencies.serde] +version = "1.0" +default-features = false + +[dependencies.serde_cbor] +version = "0.11.0" +default-features = false +optional = true + +[features] +cbor = ["serde_cbor"] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..cd482d8 --- /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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..1a8a613 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2019 Nicolas Stalder + +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..dc860af --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +## heapless-bytes + +[![crates.io][crates-image]][crates-link] +[![Documentation][docs-image]][docs-link] + +Newtype around heapless byte Vec with efficient serde. + +[crates-image]: https://img.shields.io/crates/v/heapless-bytes.svg?style=flat-square +[crates-link]: https://crates.io/crates/heapless-bytes +[docs-image]: https://img.shields.io/badge/docs.rs-api-green?style=flat-square +[docs-link]: https://docs.rs/heapless-bytes + +#### License + +`heapless-bytes` is licensed under either of [Apache License, Version 2.0](LICENSE-APACHE) or [MIT License](LICENSE-MIT) at your option. +
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..789827f --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,312 @@ +//! # heapless-bytes +//! +//! Newtype around heapless byte Vec with efficient serde. + +#![no_std] + +use core::{ + cmp::Ordering, + fmt::{self, Debug}, + hash::{Hash, Hasher}, + marker::PhantomData, + ops::{Deref, DerefMut}, +}; + +pub use heapless::consts; +pub use heapless::ArrayLength; +use heapless::Vec; + +use serde::{ + de::{Deserialize, Deserializer, Error as _, SeqAccess, Visitor}, + ser::{Serialize, Serializer}, +}; + +#[derive(Clone, Default, Eq)] +pub struct Bytes> { + bytes: Vec, +} + +impl> Bytes { + /// Construct a new, empty `Bytes`. + pub fn new() -> Self { + Bytes::from(Vec::new()) + } + + // /// Construct a new, empty `Bytes` with the specified capacity. + // pub fn with_capacity(cap: usize) -> Self { + // Bytes::from(Vec::with_capacity(cap)) + // } + + /// Wrap existing bytes in a `Bytes`. + pub fn from>>(bytes: T) -> Self { + Bytes { + bytes: bytes.into(), + } + } + + /// Unwrap the vector of byte underlying this `Bytes`. + pub fn into_vec(self) -> Vec { + self.bytes + } + + // #[doc(hidden)] + // pub fn into_iter(self) -> as IntoIterator>::IntoIter { + // self.bytes.into_iter() + // } + + pub fn try_from_slice(slice: &[u8]) -> core::result::Result { + let mut bytes = Vec::::new(); + bytes.extend_from_slice(slice)?; + Ok(Self::from(bytes)) + } + + // cf. https://internals.rust-lang.org/t/add-vec-insert-slice-at-to-insert-the-content-of-a-slice-at-an-arbitrary-index/11008/3 + pub fn insert_slice_at(&mut self, slice: &[u8], at: usize) -> core::result::Result<(), ()> { + let l = slice.len(); + let before = self.len(); + + // make space + self.bytes.resize_default(before + l)?; + + // move back existing + let raw: &mut [u8] = &mut self.bytes; + raw.copy_within(at..before, at + l); + + // insert slice + raw[at..][..l].copy_from_slice(slice); + + Ok(()) + } + + // pub fn deref_mut(&mut self) -> &mut [u8] { + // self.bytes.deref_mut() + // } + + #[cfg(feature = "cbor")] + pub fn from_serialized(t: &T) -> Self + where + T: Serialize, + { + let mut vec = Vec::::new(); + vec.resize_default(N::to_usize()).unwrap(); + let buffer = vec.deref_mut(); + + let writer = serde_cbor::ser::SliceWrite::new(buffer); + let mut ser = serde_cbor::Serializer::new(writer) + .packed_format() + // .pack_starting_with(1) + // .pack_to_depth(1) + ; + t.serialize(&mut ser).unwrap(); + let writer = ser.into_inner(); + let size = writer.bytes_written(); + vec.resize_default(size).unwrap(); + Self::from(vec) + } +} + +impl> Debug for Bytes { + fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { + // TODO: There has to be a better way :'-) + + use core::ascii::escape_default; + f.write_str("b'")?; + for byte in &self.bytes { + for ch in escape_default(*byte) { + // Debug::fmt(unsafe { core::str::from_utf8_unchecked(&[ch]) }, f)?; + f.write_str(unsafe { core::str::from_utf8_unchecked(&[ch]) })?; + // f.write(&ch); + } + } + f.write_str("'")?; + Ok(()) + } +} + +impl> AsRef<[u8]> for Bytes { + fn as_ref(&self) -> &[u8] { + &self.bytes + } +} + +impl> AsMut<[u8]> for Bytes { + fn as_mut(&mut self) -> &mut [u8] { + &mut self.bytes + } +} + +impl> Deref for Bytes { + type Target = Vec; + + fn deref(&self) -> &Self::Target { + &self.bytes + } +} + +impl> DerefMut for Bytes { + fn deref_mut(&mut self) -> &mut Self::Target { + &mut self.bytes + } +} + +// impl Borrow for Bytes { +// fn borrow(&self) -> &Bytes { +// Bytes::new(&self.bytes) +// } +// } + +// impl BorrowMut for Bytes { +// fn borrow_mut(&mut self) -> &mut Bytes { +// unsafe { &mut *(&mut self.bytes as &mut [u8] as *mut [u8] as *mut Bytes) } +// } +// } + +impl, Rhs> PartialEq for Bytes +where + Rhs: ?Sized + AsRef<[u8]>, +{ + fn eq(&self, other: &Rhs) -> bool { + self.as_ref().eq(other.as_ref()) + } +} + +impl, Rhs> PartialOrd for Bytes +where + Rhs: ?Sized + AsRef<[u8]>, +{ + fn partial_cmp(&self, other: &Rhs) -> Option { + self.as_ref().partial_cmp(other.as_ref()) + } +} + +impl> Hash for Bytes { + fn hash(&self, state: &mut H) { + self.bytes.hash(state); + } +} + +impl> IntoIterator for Bytes { + type Item = u8; + type IntoIter = as IntoIterator>::IntoIter; + + fn into_iter(self) -> Self::IntoIter { + self.bytes.into_iter() + } +} + +impl<'a, N: ArrayLength> IntoIterator for &'a Bytes { + type Item = &'a u8; + type IntoIter = <&'a [u8] as IntoIterator>::IntoIter; + + fn into_iter(self) -> Self::IntoIter { + self.bytes.iter() + } +} + +impl<'a, N: ArrayLength> IntoIterator for &'a mut Bytes { + type Item = &'a mut u8; + type IntoIter = <&'a mut [u8] as IntoIterator>::IntoIter; + + fn into_iter(self) -> Self::IntoIter { + self.bytes.iter_mut() + } +} + +impl Serialize for Bytes +where + N: ArrayLength, +{ + fn serialize(&self, serializer: S) -> Result + where + S: Serializer, + { + serializer.serialize_bytes(self) + } +} + +// TODO: can we delegate to Vec deserialization instead of reimplementing? +impl<'de, N> Deserialize<'de> for Bytes +where + N: ArrayLength, +{ + fn deserialize(deserializer: D) -> Result + where + D: Deserializer<'de>, + { + struct ValueVisitor<'de, N>(PhantomData<(&'de (), N)>); + + impl<'de, N> Visitor<'de> for ValueVisitor<'de, N> + where + N: ArrayLength, + { + // type Value = Vec; + type Value = Bytes; + + fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { + formatter.write_str("a sequence") + } + + fn visit_seq(self, mut seq: A) -> Result + where + A: SeqAccess<'de>, + { + let mut values: Vec = Vec::new(); + // hprintln!("made a values: {:?} of capacity {:?}", + // &values, N::to_usize()).ok(); + + while let Some(value) = seq.next_element()? { + if values.push(value).is_err() { + // hprintln!("error! {}", values.capacity() + 1).ok(); + // hprintln!("pushing value {:?} errored", &value).ok(); + return Err(A::Error::invalid_length(values.capacity() + 1, &self))?; + } + } + + Ok(Bytes::from(values)) + } + + fn visit_bytes(self, v: &[u8]) -> Result + where + E: serde::de::Error, + { + if v.len() > N::to_usize() { + // hprintln!("error! own size: {}, data size: {}", N::to_usize(), v.len()).ok(); + // return Err(E::invalid_length(values.capacity() + 1, &self))?; + return Err(E::invalid_length(v.len(), &self))?; + } + let mut buf: Vec = Vec::new(); + // avoid unwrapping even though redundant + match buf.extend_from_slice(v) { + Ok(()) => {} + Err(()) => { + // hprintln!("error! own size: {}, data size: {}", N::to_usize(), v.len()).ok(); + // return Err(E::invalid_length(values.capacity() + 1, &self))?; + return Err(E::invalid_length(v.len(), &self))?; + } + } + Ok(Bytes::::from(buf)) + } + } + deserializer.deserialize_seq(ValueVisitor(PhantomData)) + } +} + +#[cfg(test)] +#[cfg(feature = "cbor")] +mod tests { + use super::*; + use heapless::consts; + + #[test] + fn test_client_data_hash() { + let mut minimal = [ + 0x50u8, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x30, 0x41, 0x42, 0x43, + 0x44, 0x45, 0x46, + ]; + + let client_data_hash: Bytes = + serde_cbor::de::from_mut_slice(&mut minimal).unwrap(); + + assert_eq!(client_data_hash, b"1234567890ABCDEF"); + } +}