Struct Txid

pub struct Txid(/* private fields */);

A bitcoin transaction hash/transaction ID.

For compatibility with the existing Bitcoin infrastructure and historical and current versions of the Bitcoin Core software itself, this and other sha256d::Hash types, are serialized in reverse byte order when converted to a hex string via std::fmt::Display trait operations. See hashes::Hash::DISPLAY_BACKWARD for more details.

Implementations

impl Txid

pub fn from_raw_hash(inner: Hash) -> Txid

Creates this wrapper type from the inner hash type.

pub fn to_raw_hash(self) -> Hash

Returns the inner hash (sha256, sh256d etc.).

pub fn as_raw_hash(&self) -> &Hash

Returns a reference to the inner hash (sha256, sh256d etc.).

Trait Implementations

impl AsRef<[u8]> for Txid

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for Txid

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for Txid

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for Txid

fn clone(&self) -> Txid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Txid

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

Formats the value using the given formatter.

impl Decodable for Txid

fn consensus_decode<R>(r: &mut R) -> Result<Txid, 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<'de> Deserialize<'de> for Txid

fn deserialize<D>(d: D) -> Result<Txid, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Txid

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

Formats the value using the given formatter.

impl Encodable for Txid

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

where W: Write + ?Sized,

Encodes an object with a well-defined format.

impl From<&Transaction> for Txid

fn from(tx: &Transaction) -> Txid

Converts to this type from the input type.

impl From<Hash> for Txid

fn from(inner: Hash) -> Txid

Converts to this type from the input type.

impl From<Transaction> for Txid

fn from(tx: Transaction) -> Txid

Converts to this type from the input type.

impl From<Txid> for Hash

fn from(hashtype: Txid) -> Hash

Converts to this type from the input type.

impl From<Txid> for TxMerkleNode

fn from(txid: Txid) -> TxMerkleNode

Converts to this type from the input type.

impl FromStr for Txid

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Txid, <Txid as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Txid

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 Hash for Txid

const LEN: usize = 32usize

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = true

Flag indicating whether user-visible serializations of this hash should be backward. For some reason Satoshi decided this should be true for Sha256dHash, so here we are.

type Engine = <Hash as Hash>::Engine

A hashing engine which bytes can be serialized into. It is expected to implement the io::Write trait, and to never return errors under any conditions.

type Bytes = <Hash as Hash>::Bytes

The byte array that represents the hash internally.

fn engine() -> <Txid as Hash>::Engine

Constructs a new engine.

fn from_engine(e: <Txid as Hash>::Engine) -> Txid

Produces a hash from the current state of a given engine.

fn from_slice(sl: &[u8]) -> Result<Txid, FromSliceError>

Copies a byte slice into a hash object.

fn from_byte_array(bytes: <Txid as Hash>::Bytes) -> Txid

Constructs a hash from the underlying byte array.

fn to_byte_array(self) -> <Txid as Hash>::Bytes

Returns the underlying byte array.

fn as_byte_array(&self) -> &<Txid as Hash>::Bytes

Returns a reference to the underlying byte array.

fn all_zeros() -> Txid

Returns an all zero hash.

fn hash(data: &[u8]) -> Self

Hashes some bytes.

fn hash_byte_chunks<B, I>(byte_slices: I) -> Self

where B: AsRef<[u8]>, I: IntoIterator<Item = B>,

Hashes all the byte slices retrieved from the iterator together.

impl<I> Index<I> for Txid

where I: SliceIndex<[u8]>,

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<Txid as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for Txid

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

Formats the value using the given formatter.

impl Ord for Txid

fn cmp(&self, other: &Txid) -> 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 Txid

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

fn partial_cmp(&self, other: &Txid) -> 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 Readable for Txid

fn read<R>(r: &mut R) -> Result<Txid, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl SerdeHash for Txid

const N: usize = 32usize

Size, in bits, of the hash.

fn from_slice_delegated(sl: &[u8]) -> Result<Txid, FromSliceError>

Helper function to turn a deserialized slice into the correct hash type.

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

where S: Serializer,

Do serde serialization.

fn deserialize<'de, D>(d: D) -> Result<Self, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Do serde deserialization.

impl Serialize for Txid

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for Txid

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

Formats the value using the given formatter.

impl Writeable for Txid

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

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for Txid

impl Eq for Txid

impl StructuralPartialEq for Txid