Crate rlp

source ·
Expand description

Recursive Length Prefix serialization crate.

Allows encoding, decoding, and view onto rlp-slice

What should you use when?

Use encode function when:

  • You want to encode something inline.
  • You do not work on big set of data.
  • You want to encode whole data structure at once.

Use decode function when:

  • You want to decode something inline.
  • You do not work on big set of data.
  • You want to decode whole rlp at once.

Use RlpStream when:

  • You want to encode something in portions.
  • You encode a big set of data.

Use Rlp when:

  • You are working on trusted data (not corrupted).
  • You want to get view onto rlp-slice.
  • You don’t want to decode whole rlp at once.

Use UntrustedRlp when:

  • You are working on untrusted data (~corrupted).
  • You need to handle data corruption errors.
  • You are working on input data.
  • You want to get view onto rlp-slice.
  • You don’t want to decode whole rlp at once.

Structs

Stores basic information about item
Data-oriented view onto trusted rlp-slice.
Iterator over trusted rlp-slice list elements.
Appendable rlp encoder.
Data-oriented view onto rlp-slice.
Iterator over rlp-slice list elements.

Enums

Error concerning the RLP decoder.
RLP prototype
Type of RLP indicating its origin database.

Constants

The RLP encoded empty list.
The RLP encoded empty data (used to mean “null value”).

Traits

Trait for compressing and decompressing RLP by replacement of common terms.
RLP decodable trait
Structure encodable to RLP

Functions

Shortcut function to decode trusted rlp
Shortcut function to encode structure into rlp.