Struct Metadata 

pub struct Metadata<N>
where
    N: Network,
{ /* private fields */ }

Implementations

impl<N> Metadata<N>

where N: Network,

pub fn genesis() -> Result<Metadata<N>, Error>

Initializes the genesis metadata.

pub fn is_genesis(&self) -> Result<bool, Error>

Returns true if the metadata is a genesis metadata.

Return an error if the block is at height 0 but not a valid genesis header.

impl<N> Metadata<N>

where N: Network,

pub fn to_hash(&self) -> Result<Field<N>, Error>

Returns the metadata hash.

impl<N> Metadata<N>

where N: Network,

pub fn verify( &self, expected_round: u64, expected_height: u32, expected_cumulative_weight: u128, expected_cumulative_proof_target: u128, expected_coinbase_target: u64, expected_proof_target: u64, expected_last_coinbase_target: u64, expected_last_coinbase_timestamp: i64, expected_timestamp: i64, current_timestamp: i64, ) -> Result<(), Error>

Ensures the block metadata is correct.

impl<N> Metadata<N>

where N: Network,

pub fn new( network: u16, round: u64, height: u32, cumulative_weight: u128, cumulative_proof_target: u128, coinbase_target: u64, proof_target: u64, last_coinbase_target: u64, last_coinbase_timestamp: i64, timestamp: i64, ) -> Result<Metadata<N>, Error>

Initializes a new metadata with the given inputs.

pub fn is_valid(&self) -> bool

Returns true if the block metadata is well-formed.

Consider using Self::check_validity to get more information on invalid block metadata.

pub fn check_validity(&self) -> Result<(), Error>

Returns Ok(()) if the block metadata is well-formed, and error describing (one of) the problem(s) in the block header.

impl<N> Metadata<N>

where N: Network,

pub const fn network(&self) -> u16

Returns the network ID of the block.

pub const fn round(&self) -> u64

Returns the round number of the block.

pub const fn height(&self) -> u32

Returns the height of the block.

pub const fn cumulative_weight(&self) -> u128

Returns the cumulative weight for this block.

pub const fn cumulative_proof_target(&self) -> u128

Returns the cumulative proof target for this block.

pub const fn coinbase_target(&self) -> u64

Returns the coinbase target for this block.

pub const fn proof_target(&self) -> u64

Returns the proof target for this block.

pub const fn last_coinbase_target(&self) -> u64

Returns the coinbase target of the last coinbase.

pub const fn last_coinbase_timestamp(&self) -> i64

Returns the block timestamp of the last coinbase.

pub const fn timestamp(&self) -> i64

Returns the Unix timestamp (UTC) for this block.

Trait Implementations

impl<N> Clone for Metadata<N>

where N: Clone + Network,

fn clone(&self) -> Metadata<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Metadata<N>

where N: Network,

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

Prints the metadata as a JSON-string.

impl<'de, N> Deserialize<'de> for Metadata<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Metadata<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the metadata from a JSON-string or buffer.

impl<N> Display for Metadata<N>

where N: Network,

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

Displays the metadata as a JSON-string.

impl<N> FromBytes for Metadata<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<Metadata<N>, Error>

where R: Read,

Reads the metadata from the buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for Metadata<N>

where N: Network,

fn from_str( metadata: &str, ) -> Result<Metadata<N>, <Metadata<N> as FromStr>::Err>

Initializes the metadata from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for Metadata<N>

where N: Hash + Network,

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<N> PartialEq for Metadata<N>

where N: PartialEq + Network,

fn eq(&self, other: &Metadata<N>) -> 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<N> Serialize for Metadata<N>

where N: Network,

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

where S: Serializer,

Serializes the metadata to a JSON-string or buffer.

impl<N> ToBits for Metadata<N>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns the little-endian bits of the metadata.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns the big-endian bits of the metadata.

fn to_bits_le(&self) -> Vec<bool>

Returns self as a boolean array in little-endian order.

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBytes for Metadata<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the metadata to the buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> Copy for Metadata<N>

where N: Copy + Network,

impl<N> Eq for Metadata<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for Metadata<N>

where N: Network,