mirror of
https://github.com/google/flatbuffers.git
synced 2026-06-26 07:42:39 +00:00
Rust Flexbuffers (#5669)
* Cargo clippy lints * more lints * more lints * Restored a doc comment * Comment on float eps-eq and adjusted casting * Rust Flexbuffers * more serde tests, removed some unsafe * Redid serde to be map-like and Reader is Display * Moved iter from Reader to VectorReader * Serious quickcheck + bugs * wvo api * Made types smaller for a reasonable speedup * redid reading in a way that's a bit faster. Profiling shows the rust slowdown as building +10%, reading +20% * src/bin are developer binaries in rust * Root and Map width are not packed * key null check is debug only + doc changes * BuilderOptions * Documentation * Documentation * Moved tests to rust_usage_test * Moved rust flexbuffers samples to Flatbuffers/samples * Fixed RustTest * Fixed for Rust 1.37.0 * Upgraded to rust 1_40_0 * fixed a little-endian-only feature in a test * 1.40.0 * fixed some benchmarks for bigendian * Updated .bat file * misspelling * Gold Flexbuffer test. * Serialize,Deserialize, std::error::Error for Errors. * Undo rustfmt in integration_test.rs * from_slice instead of from_vec * Added comments to unsafe blocks * expanded on comment * bump Co-authored-by: CasperN <cneo@google.com>
This commit is contained in:
103
rust/flexbuffers/src/lib.rs
Normal file
103
rust/flexbuffers/src/lib.rs
Normal file
@@ -0,0 +1,103 @@
|
||||
// Copyright 2019 Google LLC
|
||||
//
|
||||
// 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
|
||||
//
|
||||
// https://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.
|
||||
|
||||
#![cfg_attr(test, feature(test))]
|
||||
//! Flexbuffers is a high performance schemaless binary data format designed at Google.
|
||||
//! It is complementary to the schema-ed format [Flatbuffers](http://docs.rs/flatbuffers/).
|
||||
//! See [Flexbuffer Internals](https://google.github.io/flatbuffers/flatbuffers_internals.html)
|
||||
//! for details on the binary format.
|
||||
//!
|
||||
//! * [See the examples for usage.](https://github.com/CasperN/flexbuffers/tree/master/examples)
|
||||
//!
|
||||
//! This rust implementation is in progress and, until the 1.0 release, breaking API changes may
|
||||
/// happen between minor versions.
|
||||
// TODO(cneo): serde stuff are behind a default-on feature flag
|
||||
// Reader to Json is behind a default-off feature flag
|
||||
// Serializable structs are Pushable
|
||||
// Serde with maps - field names and type names.
|
||||
|
||||
#[macro_use]
|
||||
extern crate bitflags;
|
||||
extern crate byteorder;
|
||||
#[macro_use]
|
||||
extern crate serde_derive;
|
||||
#[macro_use]
|
||||
extern crate debug_stub_derive;
|
||||
extern crate num_enum;
|
||||
#[cfg(test)]
|
||||
extern crate quickcheck;
|
||||
#[cfg(test)]
|
||||
extern crate quickcheck_derive;
|
||||
#[cfg(test)]
|
||||
extern crate rand;
|
||||
extern crate serde;
|
||||
#[cfg(test)]
|
||||
extern crate test;
|
||||
|
||||
mod bitwidth;
|
||||
mod builder;
|
||||
mod flexbuffer_type;
|
||||
mod reader;
|
||||
pub use bitwidth::BitWidth;
|
||||
pub use builder::Error as SerializationError;
|
||||
pub use builder::{
|
||||
singleton, Builder, BuilderOptions, FlexbufferSerializer, MapBuilder, Pushable, VectorBuilder,
|
||||
};
|
||||
pub use flexbuffer_type::FlexBufferType;
|
||||
pub use reader::Error as ReaderError;
|
||||
pub use reader::{DeserializationError, MapReader, Reader, ReaderIterator, VectorReader};
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
mod private {
|
||||
pub trait Sealed {}
|
||||
}
|
||||
|
||||
/// Serialize as a flexbuffer into a vector.
|
||||
pub fn to_vec<T: Serialize>(x: T) -> Result<Vec<u8>, SerializationError> {
|
||||
let mut s = FlexbufferSerializer::new();
|
||||
x.serialize(&mut s)?;
|
||||
Ok(s.take_buffer())
|
||||
}
|
||||
/// Deserialize a type from a flexbuffer.
|
||||
pub fn from_slice<'de, T: Deserialize<'de>>(buf: &'de [u8]) -> Result<T, DeserializationError> {
|
||||
let r = Reader::get_root(buf)?;
|
||||
T::deserialize(r)
|
||||
}
|
||||
|
||||
/// This struct, when pushed will be serialized as a `FlexBufferType::Blob`.
|
||||
///
|
||||
/// A `Blob` is a variable width `length` followed by that many bytes of data.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct Blob<'a>(pub &'a [u8]);
|
||||
|
||||
/// This struct, when pushed, will be serialized as a `FlexBufferType::IndirectUInt`.
|
||||
///
|
||||
/// It is an unsigned integer stored by reference in the flexbuffer. This can reduce the
|
||||
/// size of vectors and maps containing the `IndirectUInt`.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct IndirectUInt(pub u64);
|
||||
|
||||
/// This struct, when pushed, will be serialized as a `FlexBufferType::IndirectInt`.
|
||||
///
|
||||
/// It is a signed integer stored by reference in the flexbuffer. This can reduce the
|
||||
/// size of vectors and maps containing the `IndirectInt`.
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct IndirectInt(pub i64);
|
||||
|
||||
/// This struct, when pushed, will be serialized as a `FlexBufferType::IndirectFloat`.
|
||||
///
|
||||
/// It is a floating point stored by reference in the flexbuffer. This can reduce the
|
||||
/// size of vectors and maps containing the `IndirectFloat`.
|
||||
#[derive(Debug, Copy, Clone, PartialEq)]
|
||||
pub struct IndirectFloat(pub f64);
|
||||
Reference in New Issue
Block a user