Crate borsh

Crate features

Ecosystem features

• std - When enabled, this will cause borsh to use the standard library. Currently, disabling this feature will result in building the crate in no_std environment.

  Borsh has nostd_io module when compiled with std disabled. It contains a few items, counterparts of std::io items, which are used in BorshSerialize and BorshDeserialize traits’ definitions in absence of std. Most prominent of them are borsh::nostd_io::Read and borsh::nostd_io::Write traits.

Default features

• std - enabled by default.

Other features

• derive - Gates derive macros of BorshSerialize and BorshDeserialize traits.

• schema - Gates BorshSchema trait and its derive macro. Gates schema module. This feature requires derive to be enabled too.

• rc - Gates implementation of BorshSerialize and BorshDeserialize for Rc<T>/Arc<T> respectively. In no_std setting Rc/Arc are pulled from alloc crate.

• hashbrown - Pulls in HashMap/HashSet when no std is available. This feature is set to be mutually exclusive with std feature.

• bytes - Gates implementation of BorshSerialize and BorshDeserialize for Bytes and BytesMut.

• bson - Gates implementation of BorshSerialize and BorshDeserialize for ObjectId.

• de_strict_order - Enables check that keys, parsed during deserialization of HashMap/HashSet and BTreeSet/BTreeMap are encountered in ascending order with respect to PartialOrd for hash collections, and Ord for btree ones. Deserialization emits error otherwise.

  If this feature is not enabled, it is possible that two different byte slices could deserialize into the same HashMap/HashSet object.

Config aliases

• hash_collections - This is a feature alias, set up in build.rs to be equivalent to (std OR hashbrown). Gates implementation of BorshSerialize, BorshDeserialize and BorshSchema for HashMap/HashSet.

Re-exports

• pub use de::BorshDeserialize;
• pub use de::from_reader;
• pub use de::from_slice;
• pub use schema::BorshSchema;
• pub use ser::BorshSerialize;

Modules

• de
• error
• schema
  Module is available if borsh is built with features = ["derive", "schema"].
• ser

Functions

• schema_container_of
• to_vec
  Serialize an object into a vector of bytes.
• to_writer
  Serializes an object directly into a Writer.
• try_from_slice_with_schema
  Deserialize this instance from a slice of bytes, but assume that at the beginning we have bytes describing the schema of the type. We deserialize this schema and verify that it is correct.
• try_to_vec_with_schema
  Serialize object into a vector of bytes and prefix with the schema serialized as vector of bytes in Borsh format.

Derive Macros

• BorshDeserialize
  Derive macro available if borsh is built with features = ["derive"].
• BorshSchema
  Derive macro available if borsh is built with features = ["derive", "schema"].
• BorshSerialize
  Derive macro available if borsh is built with features = ["derive"].