Google Git
Sign in
android / platform / external / rust / crates / serde_cbor / e6d78d2ceff2163cf1b6c7f8e5186e779dd1ae03
commite6d78d2ceff2163cf1b6c7f8e5186e779dd1ae03[log] [tgz]
authorJoel Galenson <[email protected]>Tue Aug 24 19:56:35 2021 +0000
committerAutomerger Merge Worker <[email protected]>Tue Aug 24 19:56:35 2021 +0000
tree0eaadc9ab6b8218fd2e864c8145a6866218afab5
parentb0a4346bb49afb7963339b82827ee6cf9f4d3645 [diff]
parent59455e9323f5f5694a300986c5d869188883859e [diff]
Update TEST_MAPPING am: 3fc6ba2ebe am: 434914f3da am: 58b75ae659 am: 59455e9323

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/serde_cbor/+/1806216

Change-Id: Ic0d990362653e165d30e0909843de0e5df5e2a6a
tree: 0eaadc9ab6b8218fd2e864c8145a6866218afab5
  1. examples/
  2. src/
  3. tests/
  4. LICENSE ⇨ LICENSE-APACHE
  5. .cargo_vcs_info.json
  6. .gitignore
  7. .travis.yml
  8. Android.bp
  9. Cargo.toml
  10. Cargo.toml.orig
  11. CONTRIBUTING.md
  12. LICENSE-APACHE
  13. LICENSE-MIT
  14. METADATA
  15. MODULE_LICENSE_APACHE2
  16. OWNERS
  17. README.md
  18. TEST_MAPPING
README.md

Serde CBOR

Build Status Crates.io Documentation

This crate implements the Concise Binary Object Representation from RFC 7049. It builds on Serde, the generic serialization framework for Rust. CBOR provides a binary encoding for a superset of the JSON data model that is small and very fast to parse.

Usage

Serde CBOR supports Rust 1.40 and up. Add this to your Cargo.toml:

[dependencies]
serde_cbor = "0.11.1"

Storing and loading Rust types is easy and requires only minimal modifications to the program code.

use serde_derive::{Deserialize, Serialize};
use std::error::Error;
use std::fs::File;

// Types annotated with `Serialize` can be stored as CBOR.
// To be able to load them again add `Deserialize`.
#[derive(Debug, Serialize, Deserialize)]
struct Mascot {
    name: String,
    species: String,
    year_of_birth: u32,
}

fn main() -> Result<(), Box<dyn Error>> {
    let ferris = Mascot {
        name: "Ferris".to_owned(),
        species: "crab".to_owned(),
        year_of_birth: 2015,
    };

    let ferris_file = File::create("examples/ferris.cbor")?;
    // Write Ferris to the given file.
    // Instead of a file you can use any type that implements `io::Write`
    // like a HTTP body, database connection etc.
    serde_cbor::to_writer(ferris_file, &ferris)?;

    let tux_file = File::open("examples/tux.cbor")?;
    // Load Tux from a file.
    // Serde CBOR performs roundtrip serialization meaning that
    // the data will not change in any way.
    let tux: Mascot = serde_cbor::from_reader(tux_file)?;

    println!("{:?}", tux);
    // prints: Mascot { name: "Tux", species: "penguin", year_of_birth: 1996 }

    Ok(())
}

There are a lot of options available to customize the format. To operate on untyped CBOR values have a look at the Value type.

License

Licensed under either of

at your option.

Contribution

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.