Struct BlockHash

Source
pub struct BlockHash(/* private fields */);
Expand description

A transaction identifier (BlockHash) represented as a 32-byte hash.

BlockHash is a specialized wrapper around a 32-byte array representing a block’s unique identifier in the Zcash blockchain.

§Zcash Concept Relation

In Zcash (and Bitcoin-derived cryptocurrencies), transaction IDs are critical identifiers used to reference transactions throughout the protocol:

  • In transaction inputs to reference previous outputs being spent
  • In block data structures to identify included transactions
  • In client APIs and explorers to look up transaction details

Block hashes are displayed in reverse byte order by convention (to match Bitcoin’s historical display format), while stored internally in little-endian order.

§Data Preservation

The BlockHash type preserves the exact 32-byte transaction identifier as found in wallet data files, ensuring that transaction references maintain their cryptographic integrity during wallet migrations.

§Examples

// Create a BlockHash from a byte array
let tx_bytes = [0u8; 32];
let txid = BlockHash::from_bytes(tx_bytes);

// Display the BlockHash in the conventional reversed format used by explorers
// Note: this would display as a string of 64 hex characters (zeros in this example)
println!("Block Hash: {}", txid);

Implementations§

Source§

impl BlockHash

Source

pub fn from_bytes(bytes: [u8; 32]) -> Self

Creates a new BlockHash from a 32-byte array.

This is the primary constructor for BlockHash when you have the raw transaction hash available.

§Examples
// Usually this would be a real transaction hash
let bytes = [0u8; 32];
let txid = BlockHash::from_bytes(bytes);
Source

pub fn from_hex(hex: &str) -> Result<Self, HexParseError>

Parses a BlockHash from a canonically-encoded (byte-reversed) hexadecimal string.

§Examples

let hex = "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f";
let block_hash = BlockHash::from_hex(hex).unwrap();
assert_eq!(block_hash.as_ref()[0], 0x6f);
assert_eq!(format!("{}", block_hash), hex);
Source

pub fn read<R: Read>(reader: R) -> Result<Self>

Reads a BlockHash from any source implementing the Read trait.

This method is useful when reading transaction IDs directly from files or other byte streams.

§Errors

Returns an IO error if reading fails or if there aren’t enough bytes available.

§Examples
// Create a cursor with 32 bytes
let data = vec![0u8; 32];
let mut cursor = Cursor::new(data);

// Read a BlockHash from the cursor
let txid = BlockHash::read(&mut cursor)?;
Source

pub fn write<W: Write>(&self, writer: W) -> Result<()>

Writes a BlockHash to any destination implementing the Write trait.

This method is useful when serializing transaction IDs to files or other byte streams.

§Errors

Returns an IO error if writing fails.

§Examples
let txid = BlockHash::from_bytes([0u8; 32]);
let mut buffer = Vec::new();

// Write the BlockHash to the buffer
txid.write(&mut buffer)?;

// The buffer now contains the 32-byte transaction ID
assert_eq!(buffer.len(), 32);

Trait Implementations§

Source§

impl AsRef<[u8; 32]> for BlockHash

Source§

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

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

impl Clone for BlockHash

Source§

fn clone(&self) -> BlockHash

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BlockHash

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for BlockHash

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&BlockHash> for CBOR

Source§

fn from(value: &BlockHash) -> Self

Converts to this type from the input type.
Source§

impl From<BlockHash> for [u8; 32]

Source§

fn from(value: BlockHash) -> Self

Converts to this type from the input type.
Source§

impl From<BlockHash> for CBOR

Source§

fn from(value: BlockHash) -> Self

Converts to this type from the input type.
Source§

impl From<BlockHash> for Envelope

Source§

fn from(value: BlockHash) -> Self

Converts to this type from the input type.
Source§

impl Hash for BlockHash

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for BlockHash

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for BlockHash

Source§

fn eq(&self, other: &BlockHash) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for BlockHash

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl TryFrom<CBOR> for BlockHash

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.
Source§

impl TryFrom<Envelope> for BlockHash

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl Copy for BlockHash

Source§

impl Eq for BlockHash

Source§

impl StructuralPartialEq for BlockHash

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CBORDecodable for T
where T: TryFrom<CBOR, Error = Error>,

Source§

fn try_from_cbor(cbor: &CBOR) -> Result<Self, Error>

Source§

impl<T> CBOREncodable for T
where T: Into<CBOR> + Clone,

Source§

fn to_cbor(&self) -> CBOR

Converts this value to a CBOR object. Read more
Source§

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

Converts this value directly to binary CBOR data. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> EnvelopeEncodable for T
where T: Into<Envelope> + Clone,

Source§

fn into_envelope(self) -> Envelope

Converts the value into an envelope by using its Into<Envelope> implementation.

Source§

fn to_envelope(&self) -> Envelope
where Self: Clone,

Converts a reference to this value into a Gordian Envelope. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

Source§

impl<T> CBORCodable for T

§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSendSync for T