Trait StacksMessageCodec

pub trait StacksMessageCodec {
    // Required methods
    fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>
       where W: Write,
             Self: Sized;
    fn consensus_deserialize<R>(fd: &mut R) -> Result<Self, Error>
       where R: Read,
             Self: Sized;

    // Provided method
    fn serialize_to_vec(&self) -> Vec<u8> 
       where Self: Sized { ... }
}

Helper trait for various primitive types that make up Stacks messages

Required Methods

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write, Self: Sized,

serialize implementors should never error unless there is an underlying failure in writing to the fd

fn consensus_deserialize<R>(fd: &mut R) -> Result<Self, Error>

where R: Read, Self: Sized,

Provided Methods

fn serialize_to_vec(&self) -> Vec<u8>

where Self: Sized,

Convenience for serialization to a vec. this function unwraps any underlying serialization error

Implementations on Foreign Types

impl StacksMessageCodec for (ConsensusHash, BurnchainHeaderHash)

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>( fd: &mut R, ) -> Result<(ConsensusHash, BurnchainHeaderHash), Error>

where R: Read,

impl StacksMessageCodec for i64

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<i64, Error>

where R: Read,

impl StacksMessageCodec for u8

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<u8, Error>

where R: Read,

impl StacksMessageCodec for u16

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<u16, Error>

where R: Read,

impl StacksMessageCodec for u32

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<u32, Error>

where R: Read,

impl StacksMessageCodec for u64

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<u64, Error>

where R: Read,

impl StacksMessageCodec for [u8; 20]

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<[u8; 20], Error>

where R: Read,

impl StacksMessageCodec for [u8; 32]

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<[u8; 32], Error>

where R: Read,

impl<T> StacksMessageCodec for Vec<T>

where T: StacksMessageCodec,

fn consensus_serialize<W>(&self, fd: &mut W) -> Result<(), Error>

where W: Write,

fn consensus_deserialize<R>(fd: &mut R) -> Result<Vec<T>, Error>

where R: Read,

Implementors

impl StacksMessageCodec for Value

Note: the StacksMessageCodec implementation for Clarity values does not sanitize its serialization or deserialization.

impl StacksMessageCodec for PrincipalData

impl StacksMessageCodec for PostConditionPrincipal

impl StacksMessageCodec for TenureChangeCause

impl StacksMessageCodec for TransactionAuth

impl StacksMessageCodec for TransactionAuthField

impl StacksMessageCodec for TransactionPayload

impl StacksMessageCodec for TransactionPostCondition

impl StacksMessageCodec for TransactionSpendingCondition

impl StacksMessageCodec for BlockHeaderHash

impl StacksMessageCodec for BurnchainHeaderHash

impl StacksMessageCodec for ConsensusHash

impl StacksMessageCodec for SortitionId

impl StacksMessageCodec for StacksAddress

impl StacksMessageCodec for StacksBlockId

impl StacksMessageCodec for StacksWorkScore

impl StacksMessageCodec for TrieHash

impl StacksMessageCodec for PeerAddress

impl StacksMessageCodec for ClarityName

impl StacksMessageCodec for ContractName

impl StacksMessageCodec for stacks_codec::clarity::StacksPublicKeyBuffer

impl StacksMessageCodec for Hash160

impl StacksMessageCodec for Sha512Trunc256Sum

impl StacksMessageCodec for MessageSignature

impl StacksMessageCodec for VRFProof

impl StacksMessageCodec for AssetInfo

impl StacksMessageCodec for CoinbasePayload

impl StacksMessageCodec for MultisigSpendingCondition

impl StacksMessageCodec for SinglesigSpendingCondition

impl StacksMessageCodec for StacksMicroblockHeader

impl StacksMessageCodec for stacks_codec::codec::StacksPublicKeyBuffer

impl StacksMessageCodec for StacksString

impl StacksMessageCodec for StacksTransaction

impl StacksMessageCodec for TenureChangePayload

impl StacksMessageCodec for ThresholdSignature

impl StacksMessageCodec for TokenTransferMemo

impl StacksMessageCodec for TransactionContractCall

impl StacksMessageCodec for TransactionSmartContract

impl<const MAX_SIZE: u16> StacksMessageCodec for BitVec<MAX_SIZE>