Enum Inventory 

pub enum Inventory {
    Error,
    Transaction(Txid),
    Block(BlockHash),
    CompactBlock(BlockHash),
    WTx(Wtxid),
    WitnessTransaction(Txid),
    WitnessBlock(BlockHash),
    Unknown {
        inv_type: u32,
        hash: [u8; 32],
    },
}

An inventory item.

Variants

Error

Error — these inventories can be ignored.

This variant is never produced by decoding. Use is_error() instead to check if a decoded item represents an error.

When deserializing type 0 inventory items from the wire, they are decoded as Unknown { inv_type: 0, .. } instead. This variant exists for backwards compatibility in case calling code constructs it directly (e.g., NetworkMessage::Inv(vec![Inventory::Error])).

Transaction(Txid)

Transaction

Block(BlockHash)

Block

CompactBlock(BlockHash)

Compact Block

WTx(Wtxid)

Witness Transaction by Wtxid

WitnessTransaction(Txid)

Witness Transaction

WitnessBlock(BlockHash)

Witness Block

Unknown

Unknown inventory type

Fields

inv_type: u32

The inventory item type.

hash: [u8; 32]

The hash of the inventory item

Implementations

impl Inventory

pub fn network_hash(&self) -> Option<[u8; 32]>

Return the item value represented as a SHA256-d hash.

This always returns Some, never None even for the Error variant. The Option return type remains for backwards compatibility.

pub fn is_error(&self) -> bool

Returns true if this is an Error inventory item (type 0).

Error items are internally represented as Unknown { inv_type: 0, .. } to enable symmetric encoding/decoding while maintaining backwards compatibility.

Trait Implementations

impl Clone for Inventory

fn clone(&self) -> Inventory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Inventory

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

Formats the value using the given formatter.

impl Decodable for Inventory

fn consensus_decode<R>(r: &mut R) -> Result<Inventory, Error>

where R: Read + ?Sized,

Decode an object with a well-defined format.

fn consensus_decode_from_finite_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + ?Sized,

Decode Self from a size-limited reader.

impl Encodable for Inventory

fn consensus_encode<W>(&self, w: &mut W) -> Result<usize, Error>

where W: Write + ?Sized,

Encodes an object with a well-defined format.

impl Hash for Inventory

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Inventory

fn cmp(&self, other: &Inventory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Inventory

fn eq(&self, other: &Inventory) -> 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 PartialOrd for Inventory

fn partial_cmp(&self, other: &Inventory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Inventory

impl Eq for Inventory

impl StructuralPartialEq for Inventory