Struct BlockHash

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

A bitcoin block hash.

Implementations

impl BlockHash

pub fn from_raw_hash(inner: Hash) -> BlockHash

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 BlockHash

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

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

impl AsRef<[u8; 32]> for BlockHash

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

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

impl Borrow<[u8]> for BlockHash

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

Immutably borrows from an owned value.

impl Clone for BlockHash

fn clone(&self) -> BlockHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockHash

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

Formats the value using the given formatter.

impl Decodable for BlockHash

fn consensus_decode<R>(r: &mut R) -> Result<BlockHash, 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 BlockHash

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BlockHash

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

Formats the value using the given formatter.

impl Encodable for BlockHash

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<&Block> for BlockHash

fn from(block: &Block) -> BlockHash

Converts to this type from the input type.

impl From<&Header> for BlockHash

fn from(header: &Header) -> BlockHash

Converts to this type from the input type.

impl From<Block> for BlockHash

fn from(block: Block) -> BlockHash

Converts to this type from the input type.

impl From<BlockHash> for Hash

fn from(hashtype: BlockHash) -> Hash

Converts to this type from the input type.

impl From<Hash> for BlockHash

fn from(inner: Hash) -> BlockHash

Converts to this type from the input type.

impl From<Header> for BlockHash

fn from(header: Header) -> BlockHash

Converts to this type from the input type.

impl FromStr for BlockHash

type Err = HexToArrayError

The associated error which can be returned from parsing.

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

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

impl Hash for BlockHash

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 BlockHash

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() -> <BlockHash as Hash>::Engine

Constructs a new engine.

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

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

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

Copies a byte slice into a hash object.

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

Constructs a hash from the underlying byte array.

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

Returns the underlying byte array.

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

Returns a reference to the underlying byte array.

fn all_zeros() -> BlockHash

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 BlockHash

where I: SliceIndex<[u8]>,

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

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl LowerHex for BlockHash

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

Formats the value using the given formatter.

impl Ord for BlockHash

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

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

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

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

where R: Read,

Reads a Self in from the given Read.

impl SerdeHash for BlockHash

const N: usize = 32usize

Size, in bits, of the hash.

fn from_slice_delegated(sl: &[u8]) -> Result<BlockHash, 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 BlockHash

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 BlockHash

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

Formats the value using the given formatter.

impl Writeable for BlockHash

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 BlockHash

impl Eq for BlockHash

impl StructuralPartialEq for BlockHash