Files
pezkuwi-subxt/polkadot/node/subsystem/src/lib.rs
T
Shawn Tabrizi ff5d56fb76 cargo +nightly fmt (#3540)
* cargo +nightly fmt

* add cargo-fmt check to ci

* update ci

* fmt

* fmt

* skip macro

* ignore bridges
2021-08-02 10:47:33 +00:00

89 lines
2.9 KiB
Rust

// Copyright 2017-2020 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot 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.
// Polkadot 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 Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! Subsystem accumulation.
//!
//! Node-side types and generated overseer.
#![deny(missing_docs)]
#![deny(unused_crate_dependencies)]
pub use jaeger::*;
pub use polkadot_node_jaeger as jaeger;
pub use polkadot_overseer::{self as overseer, ActiveLeavesUpdate, OverseerSignal};
pub use polkadot_node_subsystem_types::{
errors::{self, *},
ActivatedLeaf, LeafStatus,
};
/// Re-export of all messages type, including the wrapper type.
pub mod messages {
pub use super::overseer::AllMessages;
pub use polkadot_node_subsystem_types::messages::*;
}
/// A `Result` type that wraps [`SubsystemError`].
///
/// [`SubsystemError`]: struct.SubsystemError.html
pub type SubsystemResult<T> = Result<T, SubsystemError>;
// Simplify usage without having to do large scale modifications of all
// subsystems at once.
/// Specialized message type originating from the overseer.
pub type FromOverseer<M> = polkadot_overseer::gen::FromOverseer<M, OverseerSignal>;
/// Specialized subsystem instance type of subsystems consuming a particular message type.
pub type SubsystemInstance<Message> =
polkadot_overseer::gen::SubsystemInstance<Message, OverseerSignal>;
/// Sender trait for the `AllMessages` wrapper.
pub trait SubsystemSender: polkadot_overseer::gen::SubsystemSender<messages::AllMessages> {}
impl<T> SubsystemSender for T where T: polkadot_overseer::gen::SubsystemSender<messages::AllMessages>
{}
/// Spawned subsystem.
pub type SpawnedSubsystem = polkadot_overseer::gen::SpawnedSubsystem<SubsystemError>;
/// Convenience trait specialization.
pub trait SubsystemContext:
polkadot_overseer::gen::SubsystemContext<
Signal = OverseerSignal,
AllMessages = messages::AllMessages,
Error = SubsystemError,
>
{
/// The message type the subsystem consumes.
type Message: std::fmt::Debug + Send + 'static;
/// Sender type to communicate with other subsystems.
type Sender: SubsystemSender + Send + Clone + 'static;
}
impl<T> SubsystemContext for T
where
T: polkadot_overseer::gen::SubsystemContext<
Signal = OverseerSignal,
AllMessages = messages::AllMessages,
Error = SubsystemError,
>,
{
type Message = <Self as polkadot_overseer::gen::SubsystemContext>::Message;
type Sender = <Self as polkadot_overseer::gen::SubsystemContext>::Sender;
}