common-types 0.1.0

Tetsy Vapory Common Types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// Copyright 2015-2020 Parity Technologies (UK) Ltd.
// This file is part of Tetsy Vapory.

// Tetsy Vapory is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// Tetsy Vapory is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with Tetsy Vapory.  If not, see <http://www.gnu.org/licenses/>.

//! Defines the `ClientIoMessage` type, used pervasively throughout various parts of the project to
//! communicate between each other.

use std::fmt;
use bytes::Bytes;
use vapory_types::H256;
use crate::snapshot::ManifestData;

/// Message type for external and internal events
#[derive(Debug)]
pub enum ClientIoMessage<C> {
	/// Best Block Hash in chain has been changed
	NewChainHead,
	/// A block is ready
	BlockVerified,
	/// Begin snapshot restoration
	BeginRestoration(ManifestData),
	/// Feed a state chunk to the snapshot service
	FeedStateChunk(H256, Bytes),
	/// Feed a block chunk to the snapshot service
	FeedBlockChunk(H256, Bytes),
	/// Take a snapshot for the block with given number.
	TakeSnapshot(u64),
	/// Execute wrapped closure
	Execute(Callback<C>),
}

impl<C> ClientIoMessage<C> {
	/// Create new `ClientIoMessage` that executes given procedure.
	pub fn execute<F: Fn(&C) + Send + Sync + 'static>(fun: F) -> Self {
		ClientIoMessage::Execute(Callback(Box::new(fun)))
	}
}

/// A function to invoke in the client thread.
pub struct Callback<C>(pub Box<dyn Fn(&C) + Send + Sync>);

impl<C> fmt::Debug for Callback<C> {
	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
		write!(fmt, "<callback>")
	}
}