Skip to content
Snippets Groups Projects
Commit add15579 authored by Aditya Belsare's avatar Aditya Belsare Committed by Automerger Merge Worker
Browse files

Import ciborium-io crate. am: 66843400

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/ciborium-io/+/1967059

Change-Id: Ibffd31f1acf6acb53ca65b3f5ad4ea33cd7f9452
parents dc70373e 66843400
No related branches found
No related tags found
No related merge requests found
// This file is generated by cargo2android.py --run --device --dependencies.
// Do not modify this file as changes will be overridden on upgrade.
rust_library {
name: "libciborium_io",
host_supported: true,
crate_name: "ciborium_io",
cargo_env_compat: true,
cargo_pkg_version: "0.2.0",
srcs: ["src/lib.rs"],
edition: "2021",
}
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
name = "ciborium-io"
version = "0.2.0"
authors = ["Nathaniel McCallum <npmccallum@profian.com>"]
description = "Simplified Read/Write traits for no_std usage"
homepage = "https://github.com/enarx/ciborium"
readme = "README.md"
keywords = ["io", "read", "write"]
categories = ["data-structures", "embedded", "no-std"]
license = "Apache-2.0"
repository = "https://github.com/enarx/ciborium"
[features]
alloc = []
std = ["alloc"]
[badges.github]
repository = "enarx/ciborium"
workflow = "test"
[badges.is-it-maintained-issue-resolution]
repository = "enarx/ciborium"
[badges.is-it-maintained-open-issues]
repository = "enarx/ciborium"
[badges.maintenance]
status = "actively-developed"
[package]
name = "ciborium-io"
version = "0.2.0"
authors = ["Nathaniel McCallum <npmccallum@profian.com>"]
license = "Apache-2.0"
edition = "2021"
homepage = "https://github.com/enarx/ciborium"
repository = "https://github.com/enarx/ciborium"
description = "Simplified Read/Write traits for no_std usage"
readme = "README.md"
keywords = ["io", "read", "write"]
categories = ["data-structures", "embedded", "no-std"]
[badges]
# See https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section
github = { repository = "enarx/ciborium", workflow = "test" }
#github = { repository = "enarx/ciborium", workflow = "lint" }
maintenance = { status = "actively-developed" }
is-it-maintained-issue-resolution = { repository = "enarx/ciborium" }
is-it-maintained-open-issues = { repository = "enarx/ciborium" }
[features]
alloc = []
std = ["alloc"]
LICENSE 0 → 100644
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:
You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
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
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
METADATA 0 → 100644
name: "ciborium-io"
description:
"Simplified Read/Write traits for no_std usage"
third_party {
url {
type: HOMEPAGE
value: "https://crates.io/crates/ciborium-io/0.2.0"
}
url {
type: ARCHIVE
value: "https://static.crates.io/crates/ciborium-io/ciborium-io-0.2.0.crate"
}
version: "0.2.0"
last_upgrade_date { year: 2022 month: 1 day: 17 }
license_type: NOTICE
}
OWNERS 0 → 100644
include platform/prebuilts/rust:master:/OWNERS
# Android Hardware Security
asbel@google.com
jbires@google.com
paulcrowley@google.com
[![Workflow Status](https://github.com/enarx/ciborium/workflows/test/badge.svg)](https://github.com/enarx/ciborium/actions?query=workflow%3A%22test%22)
[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/enarx/ciborium.svg)](https://isitmaintained.com/project/enarx/ciborium "Average time to resolve an issue")
[![Percentage of issues still open](https://isitmaintained.com/badge/open/enarx/ciborium.svg)](https://isitmaintained.com/project/enarx/ciborium "Percentage of issues still open")
![Maintenance](https://img.shields.io/badge/maintenance-activly--developed-brightgreen.svg)
# ciborium-io
Simple, Low-level I/O traits
This crate provides two simple traits: `Read` and `Write`. These traits
mimic their counterparts in `std::io`, but are trimmed for simplicity
and can be used in `no_std` and `no_alloc` environments. Since this
crate contains only traits, inline functions and unit structs, it should
be a zero-cost abstraction.
If the `std` feature is enabled, we provide blanket implementations for
all `std::io` types. If the `alloc` feature is enabled, we provide
implementations for `Vec<u8>`. In all cases, you get implementations
for byte slices. You can, of course, implement the traits for your own
types.
License: Apache-2.0
diff --git a/src/lib.rs b/src/lib.rs
index c887e19..0594e8c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -19,6 +19,8 @@
#![deny(clippy::all)]
#![deny(clippy::cargo)]
+extern crate std;
+
#[cfg(feature = "alloc")]
extern crate alloc;
// SPDX-License-Identifier: Apache-2.0
//! Simple, Low-level I/O traits
//!
//! This crate provides two simple traits: `Read` and `Write`. These traits
//! mimic their counterparts in `std::io`, but are trimmed for simplicity
//! and can be used in `no_std` and `no_alloc` environments. Since this
//! crate contains only traits, inline functions and unit structs, it should
//! be a zero-cost abstraction.
//!
//! If the `std` feature is enabled, we provide blanket implementations for
//! all `std::io` types. If the `alloc` feature is enabled, we provide
//! implementations for `Vec<u8>`. In all cases, you get implementations
//! for byte slices. You can, of course, implement the traits for your own
//! types.
#![cfg_attr(not(feature = "std"), no_std)]
#![deny(missing_docs)]
#![deny(clippy::all)]
#![deny(clippy::cargo)]
extern crate std;
#[cfg(feature = "alloc")]
extern crate alloc;
/// A trait indicating a type that can read bytes
///
/// Note that this is similar to `std::io::Read`, but simplified for use in a
/// `no_std` context.
pub trait Read {
/// The error type
type Error;
/// Reads exactly `data.len()` bytes or fails
fn read_exact(&mut self, data: &mut [u8]) -> Result<(), Self::Error>;
}
/// A trait indicating a type that can write bytes
///
/// Note that this is similar to `std::io::Write`, but simplified for use in a
/// `no_std` context.
pub trait Write {
/// The error type
type Error;
/// Writes all bytes from `data` or fails
fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error>;
/// Flushes all output
fn flush(&mut self) -> Result<(), Self::Error>;
}
#[cfg(feature = "std")]
impl<T: std::io::Read> Read for T {
type Error = std::io::Error;
#[inline]
fn read_exact(&mut self, data: &mut [u8]) -> Result<(), Self::Error> {
self.read_exact(data)
}
}
#[cfg(feature = "std")]
impl<T: std::io::Write> Write for T {
type Error = std::io::Error;
#[inline]
fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error> {
self.write_all(data)
}
#[inline]
fn flush(&mut self) -> Result<(), Self::Error> {
self.flush()
}
}
#[cfg(not(feature = "std"))]
impl<R: Read + ?Sized> Read for &mut R {
type Error = R::Error;
#[inline]
fn read_exact(&mut self, data: &mut [u8]) -> Result<(), Self::Error> {
(**self).read_exact(data)
}
}
#[cfg(not(feature = "std"))]
impl<W: Write + ?Sized> Write for &mut W {
type Error = W::Error;
#[inline]
fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error> {
(**self).write_all(data)
}
#[inline]
fn flush(&mut self) -> Result<(), Self::Error> {
(**self).flush()
}
}
/// An error indicating there are no more bytes to read
#[cfg(not(feature = "std"))]
#[derive(Debug)]
pub struct EndOfFile(());
#[cfg(not(feature = "std"))]
impl Read for &[u8] {
type Error = EndOfFile;
#[inline]
fn read_exact(&mut self, data: &mut [u8]) -> Result<(), Self::Error> {
if data.len() > self.len() {
return Err(EndOfFile(()));
}
let (prefix, suffix) = self.split_at(data.len());
data.copy_from_slice(prefix);
*self = suffix;
Ok(())
}
}
/// An error indicating that the output cannot accept more bytes
#[cfg(not(feature = "std"))]
#[derive(Debug)]
pub struct OutOfSpace(());
#[cfg(not(feature = "std"))]
impl Write for &mut [u8] {
type Error = OutOfSpace;
#[inline]
fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error> {
if data.len() > self.len() {
return Err(OutOfSpace(()));
}
let (prefix, suffix) = core::mem::replace(self, &mut []).split_at_mut(data.len());
prefix.copy_from_slice(data);
*self = suffix;
Ok(())
}
#[inline]
fn flush(&mut self) -> Result<(), Self::Error> {
Ok(())
}
}
#[cfg(all(not(feature = "std"), feature = "alloc"))]
impl Write for alloc::vec::Vec<u8> {
type Error = core::convert::Infallible;
#[inline]
fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error> {
self.extend_from_slice(data);
Ok(())
}
#[inline]
fn flush(&mut self) -> Result<(), Self::Error> {
Ok(())
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn read_eof() {
let mut reader = &[1u8; 0][..];
let mut buffer = [0u8; 1];
reader.read_exact(&mut buffer[..]).unwrap_err();
}
#[test]
fn read_one() {
let mut reader = &[1u8; 1][..];
let mut buffer = [0u8; 1];
reader.read_exact(&mut buffer[..]).unwrap();
assert_eq!(buffer[0], 1);
reader.read_exact(&mut buffer[..]).unwrap_err();
}
#[test]
fn read_two() {
let mut reader = &[1u8; 2][..];
let mut buffer = [0u8; 1];
reader.read_exact(&mut buffer[..]).unwrap();
assert_eq!(buffer[0], 1);
reader.read_exact(&mut buffer[..]).unwrap();
assert_eq!(buffer[0], 1);
reader.read_exact(&mut buffer[..]).unwrap_err();
}
#[test]
#[cfg(feature = "std")]
fn read_std() {
let mut reader = std::io::repeat(1);
let mut buffer = [0u8; 2];
reader.read_exact(&mut buffer[..]).unwrap();
assert_eq!(buffer[0], 1);
assert_eq!(buffer[1], 1);
}
#[test]
fn write_oos() {
let mut writer = &mut [0u8; 0][..];
writer.write_all(&[1u8; 1][..]).unwrap_err();
}
#[test]
fn write_one() {
let mut buffer = [0u8; 1];
let mut writer = &mut buffer[..];
writer.write_all(&[1u8; 1][..]).unwrap();
writer.write_all(&[1u8; 1][..]).unwrap_err();
assert_eq!(buffer[0], 1);
}
#[test]
fn write_two() {
let mut buffer = [0u8; 2];
let mut writer = &mut buffer[..];
writer.write_all(&[1u8; 1][..]).unwrap();
writer.write_all(&[1u8; 1][..]).unwrap();
writer.write_all(&[1u8; 1][..]).unwrap_err();
assert_eq!(buffer[0], 1);
assert_eq!(buffer[1], 1);
}
#[test]
#[cfg(feature = "alloc")]
fn write_vec() {
let mut buffer = alloc::vec::Vec::new();
buffer.write_all(&[1u8; 1][..]).unwrap();
buffer.write_all(&[1u8; 1][..]).unwrap();
assert_eq!(buffer.len(), 2);
assert_eq!(buffer[0], 1);
assert_eq!(buffer[1], 1);
}
#[test]
#[cfg(feature = "std")]
fn write_std() {
let mut writer = std::io::sink();
writer.write_all(&[1u8; 1][..]).unwrap();
writer.write_all(&[1u8; 1][..]).unwrap();
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment