Struct BatchHeader 

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

Implementations

impl<N> BatchHeader<N>

where N: Network,

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

Returns the batch ID.

impl<N> BatchHeader<N>

where N: Network,

pub fn compute_batch_id( version: u8, author: Address<N>, round: u64, timestamp: i64, transmission_ids: &IndexSet<TransmissionID<N>>, previous_certificate_ids: &IndexSet<Field<N>>, last_election_certificate_ids: &IndexSet<Field<N>>, ) -> Result<Field<N>, Error>

Returns the batch ID.

impl<N> BatchHeader<N>

where N: Network,

pub const MAX_CERTIFICATES: usize = 200usize

The maximum number of certificates in a batch.

pub const MAX_SOLUTIONS: usize = N::MAX_SOLUTIONS

The maximum number of solutions in a batch.

pub const MAX_TRANSACTIONS: usize = 65_536usize

The maximum number of transactions in a batch.

pub const MAX_TRANSMISSIONS: usize

The maximum number of transmissions in a batch.

impl<N> BatchHeader<N>

where N: Network,

pub fn new<R>( private_key: &PrivateKey<N>, round: u64, timestamp: i64, transmission_ids: IndexSet<TransmissionID<N>>, previous_certificate_ids: IndexSet<Field<N>>, last_election_certificate_ids: IndexSet<Field<N>>, rng: &mut R, ) -> Result<BatchHeader<N>, Error>

where R: Rng + CryptoRng,

Initializes a new batch header.

pub fn from( version: u8, author: Address<N>, round: u64, timestamp: i64, transmission_ids: IndexSet<TransmissionID<N>>, previous_certificate_ids: IndexSet<Field<N>>, last_election_certificate_ids: IndexSet<Field<N>>, signature: Signature<N>, ) -> Result<BatchHeader<N>, Error>

Initializes a new batch header.

impl<N> BatchHeader<N>

where N: Network,

pub const fn batch_id(&self) -> Field<N>

Returns the batch ID.

pub const fn author(&self) -> Address<N>

Returns the author.

pub const fn round(&self) -> u64

Returns the round number.

pub const fn timestamp(&self) -> i64

Returns the timestamp.

pub const fn transmission_ids(&self) -> &IndexSet<TransmissionID<N>>

Returns the transmission IDs.

pub const fn previous_certificate_ids(&self) -> &IndexSet<Field<N>>

Returns the batch certificate IDs for the previous round.

pub const fn last_election_certificate_ids(&self) -> &IndexSet<Field<N>>

Returns the last election batch certificate IDs.

pub const fn signature(&self) -> &Signature<N>

Returns the signature.

impl<N> BatchHeader<N>

where N: Network,

pub fn is_empty(&self) -> bool

Returns true if the batch header is empty.

pub fn len(&self) -> usize

Returns the number of transmissions in the batch header.

pub fn contains(&self, transmission_id: impl Into<TransmissionID<N>>) -> bool

Returns true if the batch contains the specified transmission ID.

Trait Implementations

impl<N> Clone for BatchHeader<N>

where N: Clone + Network,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for BatchHeader<N>

where N: Network,

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

Prints the batch header as a JSON-string.

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

where N: Network,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N> Display for BatchHeader<N>

where N: Network,

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

Displays the batch header as a JSON-string.

impl<N> FromBytes for BatchHeader<N>

where N: Network,

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

where R: Read,

Reads the batch header 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.

impl<N> FromStr for BatchHeader<N>

where N: Network,

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

Initializes the batch header from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> PartialEq for BatchHeader<N>

where N: PartialEq + Network,

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

where N: Network,

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<N> ToBytes for BatchHeader<N>

where N: Network,

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

where W: Write,

Writes the batch header 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> Eq for BatchHeader<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for BatchHeader<N>

where N: Network,