Struct exonum::messages::Propose

pub struct Propose { /* fields omitted */ }

Proposal for a new block.

Validation

The message is ignored if it * contains incorrect prev_hash * is sent by non-leader * contains already committed transactions * is already known

Processing

If the message contains unknown transactions, then TransactionsRequest is sent in reply. Otherwise Prevote is broadcast.

Generation

A node broadcasts Propose if it is a leader and is not locked for a different proposal. Also Propose can be sent as response to ProposeRequest.

Methods

impl Propose

pub fn new(
    validator: ValidatorId,
    height: Height,
    round: Round,
    prev_hash: &Hash,
    transactions: &[Hash],
    secret_key: &SecretKey
) -> Propose

Creates message and signs it.

pub fn new_with_signature(
    validator: ValidatorId,
    height: Height,
    round: Round,
    prev_hash: &Hash,
    transactions: &[Hash],
    signature: &Signature
) -> Propose

Creates message and appends existing signature.

pub fn to_hex(&self) -> String

Returns the hex representation of the binary data. Lower case letters are used (e.g. f9b4ca).

pub fn validator(&self) -> ValidatorId

The validator id.

pub fn height(&self) -> Height

The height to which the message is related.

pub fn round(&self) -> Round

The round to which the message is related.

pub fn prev_hash(&self) -> &Hash

Hash of the previous block.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

pub fn transactions(&self) -> &[Hash]

The list of transactions to include in the next block.

Trait Implementations

impl Clone for Propose

fn clone(&self) -> Propose

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq for Propose

fn eq(&self, __arg_0: &Propose) -> bool

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

fn ne(&self, __arg_0: &Propose) -> bool

This method tests for !=.

impl ServiceMessage for Propose

const SERVICE_ID: u16

SERVICE_ID: u16 = CONSENSUS

ID of the service this message belongs to.

const MESSAGE_ID: u16

MESSAGE_ID: u16 = 0 + 1 + 1

ID of the message itself. Should be unique within a service.

impl Message for Propose

fn from_raw(raw: RawMessage) -> Result<Propose, Error>

Converts the raw message into the specific one.

fn raw(&self) -> &RawMessage

Returns raw message.

fn verify_signature(&self, pub_key: &PublicKey) -> bool

Verifies the message using given public key.

impl<'a> SegmentField<'a> for Propose

fn item_size() -> Offset

size of item fixed part that this Field collect.

fn count(&self) -> Offset

count of items in collection

fn extend_buffer(&self, buffer: &mut Vec<u8>)

extend buffer with this collection

unsafe fn from_buffer(buffer: &'a [u8], from: Offset, count: Offset) -> Self

create collection from buffer

fn check_data(
    buffer: &'a [u8],
    from: CheckedOffset,
    count: CheckedOffset,
    latest_segment: CheckedOffset
) -> Result

check collection data

impl AsRef<RawMessage> for Propose

fn as_ref(&self) -> &RawMessage

Performs the conversion.

impl FromHex for Propose

type Error = Error

fn from_hex<T: AsRef<[u8]>>(hex: T) -> Result<Self, Self::Error>

Creates an instance of type Self from the given hex string, or fails with a custom error type.

impl StorageValue for Propose

Important traits for Vec<u8>

impl Write for Vec<u8>

fn into_bytes(self) -> Vec<u8>

Serialize a value into a vector of bytes.

fn from_bytes(value: Cow<[u8]>) -> Self

Deserialize a value from bytes.

impl Debug for Propose

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

Formats the value using the given formatter.

impl ExonumJson for Propose

fn deserialize_field<B>(
    value: &Value,
    buffer: &mut B,
    from: Offset,
    to: Offset
) -> Result<(), Box<Error>> where
    B: WriteBufferWrapper, 

write deserialized field in buffer on place.

fn serialize_field(&self) -> Result<Value, Box<Error + Send + Sync>>

serialize field as json::Value

impl ExonumJsonDeserialize for Propose

fn deserialize(value: &Value) -> Result<Self, Box<Error>>

deserialize json value.

impl<'de> Deserialize<'de> for Propose

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Propose

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

Serialize this value into the given Serde serializer.