bitcoin-consensus-encoding 0.1.0

Consensus encoding and decoding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

// SPDX-License-Identifier: CC0-1.0

//! # Rust Bitcoin - consensus encoding and decoding
//!
//! This library provides traits that can be used to encode/decode objects in a
//! consensus-consistent way.
//!

#![no_std]
// Coding conventions.
#![warn(missing_docs)]
#![warn(deprecated_in_future)]
#![doc(test(attr(warn(unused))))]

#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;

mod decode;
mod encode;

pub use self::decode::decoders::{
    ArrayDecoder, CompactSizeDecoder, CompactSizeDecoderError, Decoder2, Decoder2Error, Decoder3,
    Decoder3Error, Decoder4, Decoder4Error, Decoder6, Decoder6Error, UnexpectedEofError,
};
#[cfg(feature = "alloc")]
pub use self::decode::decoders::{
    ByteVecDecoder, ByteVecDecoderError, LengthPrefixExceedsMaxError, VecDecoder, VecDecoderError,
};
#[cfg(feature = "std")]
pub use self::decode::{
    decode_from_read, decode_from_read_unbuffered, decode_from_read_unbuffered_with, ReadError,
};
pub use self::decode::{decode_from_slice, Decodable, Decoder};
pub use self::encode::encoders::{
    ArrayEncoder, ArrayRefEncoder, BytesEncoder, CompactSizeEncoder, Encoder2, Encoder3, Encoder4,
    Encoder6, SliceEncoder,
};
#[cfg(feature = "alloc")]
pub use self::encode::{encode_to_vec, flush_to_vec};
#[cfg(feature = "std")]
pub use self::encode::{encode_to_writer, flush_to_writer};
pub use self::encode::{Encodable, EncodableByteIter, Encoder, ExactSizeEncoder};