Struct bitcoin::constants::ChainHash

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

The uniquely identifying hash of the target blockchain.

Implementations

impl ChainHash

pub fn as_ptr(&self) -> *const u8

Converts the object to a raw pointer.

pub fn as_mut_ptr(&mut self) -> *mut u8

Converts the object to a mutable raw pointer.

pub fn len(&self) -> usize

Returns the length of the object as an array.

pub fn is_empty(&self) -> bool

Returns whether the object, as an array, is empty. Always false.

impl ChainHash

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

Returns a reference the underlying bytes.

pub fn to_bytes(self) -> [u8; 32]

Returns the underlying bytes.

pub fn from_hex(s: &str) -> Result<Self, HexToArrayError>

Creates Self from a hex string.

impl ChainHash

pub const BITCOIN: Self = _

ChainHash for mainnet bitcoin.

pub const TESTNET: Self = _

ChainHash for testnet bitcoin.

pub const SIGNET: Self = _

ChainHash for signet bitcoin.

pub const REGTEST: Self = _

ChainHash for regtest bitcoin.

pub fn using_genesis_block(params: impl AsRef<Params>) -> Self

Returns the hash of the network genesis block for use as a chain hash.

See BOLT 0 for specification.

pub const fn using_genesis_block_const(network: Network) -> Self

Returns the hash of the network genesis block for use as a chain hash.

See BOLT 0 for specification.

pub fn from_genesis_block_hash(block_hash: BlockHash) -> Self

Converts genesis block hash into ChainHash.

Trait Implementations

impl AsMut<[u8]> for ChainHash

fn as_mut(&mut self) -> &mut [u8]

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

impl AsMut<[u8; 32]> for ChainHash

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

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

impl AsRef<[u8]> for ChainHash

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

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

impl AsRef<[u8; 32]> for ChainHash

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

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

impl Borrow<[u8]> for ChainHash

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

Immutably borrows from an owned value.

impl Borrow<[u8; 32]> for ChainHash

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

Immutably borrows from an owned value.

impl BorrowMut<[u8]> for ChainHash

fn borrow_mut(&mut self) -> &mut [u8]

Mutably borrows from an owned value.

impl BorrowMut<[u8; 32]> for ChainHash

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

Mutably borrows from an owned value.

impl Clone for ChainHash

fn clone(&self) -> ChainHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChainHash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChainHash

Available on crate feature serde only.

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

Deserialize this value from the given Serde deserializer.

impl Display for ChainHash

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8; 32]> for ChainHash

fn from(data: &'a [u8; 32]) -> Self

Converts to this type from the input type.

impl<'a> From<[u8; 32]> for ChainHash

fn from(data: [u8; 32]) -> Self

Converts to this type from the input type.

impl FromStr for ChainHash

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

impl Hash for ChainHash

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

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<I> Index<I> for ChainHash

where [u8]: Index<I>,

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

The returned type after indexing.

fn index(&self, index: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl LowerHex for ChainHash

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

Formats the value using the given formatter.

impl Ord for ChainHash

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

Restrict a value to a certain interval.

impl PartialEq for ChainHash

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ChainHash

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ChainHash

Available on crate feature serde only.

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a [u8]> for ChainHash

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(data: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ChainHash> for Network

type Error = UnknownChainHashError

The type returned in the event of a conversion error.

fn try_from(chain_hash: ChainHash) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for ChainHash

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

Formats the value using the given formatter.

impl Copy for ChainHash

impl Eq for ChainHash

impl StructuralPartialEq for ChainHash