Struct AnyReceiptEnvelope

pub struct AnyReceiptEnvelope<T = Log> {
    pub inner: ReceiptWithBloom<T>,
    pub type: u8,
}

Receipt envelope, as defined in EIP-2718.

This enum distinguishes between tagged and untagged legacy receipts, as the in-protocol Merkle tree may commit to EITHER 0-prefixed or raw. Therefore we must ensure that encoding returns the precise byte-array that was decoded, preserving the presence or absence of the TransactionType flag.

Transaction receipt payloads are specified in their respective EIPs.

Fields

inner: ReceiptWithBloom<T>

The receipt envelope.

type: u8

The transaction type.

Implementations

impl<T> AnyReceiptEnvelope<T>

where T: Encodable,

pub fn rlp_payload_length(&self) -> usize

Calculate the length of the rlp payload of the network encoded receipt.

impl<T> AnyReceiptEnvelope<T>

pub const fn is_legacy(&self) -> bool

Returns whether this is a legacy receipt (type 0)

pub const fn is_success(&self) -> bool

Return true if the transaction was successful.

Note

This method may not accurately reflect the status of the transaction for transactions before EIP-658.

pub const fn status(&self) -> bool

Returns the success status of the receipt’s transaction.

Note

This method may not accurately reflect the status of the transaction for transactions before EIP-658.

pub const fn bloom(&self) -> Bloom

Return the receipt’s bloom.

pub const fn cumulative_gas_used(&self) -> u128

Returns the cumulative gas used at this receipt.

pub fn logs(&self) -> &[T]

Return the receipt logs.

Trait Implementations

impl<T> Clone for AnyReceiptEnvelope<T>

where T: Clone,

fn clone(&self) -> AnyReceiptEnvelope<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for AnyReceiptEnvelope<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Decodable2718 for AnyReceiptEnvelope

fn typed_decode( ty: u8, buf: &mut &[u8], ) -> Result<AnyReceiptEnvelope, Eip2718Error>

Decode the appropriate variant, based on the type flag.

fn fallback_decode(buf: &mut &[u8]) -> Result<AnyReceiptEnvelope, Eip2718Error>

Decode the default variant.

fn extract_type_byte(buf: &mut &[u8]) -> Option<u8>

Extract the type byte from the buffer, if any. The type byte is the first byte, provided that that first byte is 0x7f or lower.

fn decode_2718(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn network_decode(buf: &mut &[u8]) -> Result<Self, Eip2718Error>

Decode an EIP-2718 transaction in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl<'de, T> Deserialize<'de> for AnyReceiptEnvelope<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<AnyReceiptEnvelope<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable2718 for AnyReceiptEnvelope

fn type_flag(&self) -> Option<u8>

Return the type flag (if any).

fn encode_2718_len(&self) -> usize

The length of the 2718 encoded envelope. This is the length of the type flag + the length of the inner encoding.

fn encode_2718(&self, out: &mut dyn BufMut)

Encode the transaction according to EIP-2718 rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn is_legacy(&self) -> bool

True if the envelope is the legacy variant.

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

Encode the transaction according to [EIP-2718] rules. First a 1-byte type flag in the range 0x0-0x7f, then the body of the transaction.

fn trie_hash(&self) -> FixedBytes<32>

Compute the hash as committed to in the MPT trie. This hash is used ONLY by the Ethereum merkle-patricia trie and associated proofs. Do not call this method unless you are building a full or light client.

fn seal(self) -> Sealed<Self>

Seal the encodable, by encoding and hashing it.

fn network_len(&self) -> usize

The length of the 2718 encoded envelope in network format. This is the length of the header + the length of the type flag and inner encoding.

fn network_encode(&self, out: &mut dyn BufMut)

Encode in the network format. The network format is used ONLY by the Ethereum p2p protocol. Do not call this method unless you are building a p2p protocol client.

impl<T> PartialEq for AnyReceiptEnvelope<T>

where T: PartialEq,

fn eq(&self, other: &AnyReceiptEnvelope<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for AnyReceiptEnvelope<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> TxReceipt<T> for AnyReceiptEnvelope<T>

where T: Clone + Debug + PartialEq + Eq + Send + Sync,

fn status_or_post_state(&self) -> Eip658Value

Returns the status or post state of the transaction.

fn status(&self) -> bool

Returns true if the transaction was successful OR if the transaction is pre-EIP-658. Results for transactions before EIP-658 are not reliable.

fn bloom(&self) -> Bloom

Returns the bloom filter for the logs in the receipt. This operation may be expensive.

fn cumulative_gas_used(&self) -> u128

Returns the cumulative gas used in the block after this transaction was executed.

fn logs(&self) -> &[T]

Returns the logs emitted by this transaction.

fn bloom_cheap(&self) -> Option<Bloom>

Returns the bloom filter for the logs in the receipt, if it is cheap to compute.

impl<T> Eq for AnyReceiptEnvelope<T>

where T: Eq,

impl<T> StructuralPartialEq for AnyReceiptEnvelope<T>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 352 bytes