gear_core/message/
signal.rs

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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
// This file is part of Gear.

// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program 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.

// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.

use crate::{
    ids::{prelude::*, MessageId, ProgramId},
    message::{Dispatch, DispatchKind, Message, SignalDetails},
};
use gear_core_errors::SignalCode;
use scale_info::{
    scale::{Decode, Encode},
    TypeInfo,
};

/// Message for signal entry point.
#[derive(Clone, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct SignalMessage {
    /// Message id.
    id: MessageId,
    /// Reply status code.
    code: SignalCode,
}

impl SignalMessage {
    /// Creates a new [`SignalMessage`].
    pub fn new(origin_msg_id: MessageId, code: SignalCode) -> Self {
        let id = MessageId::generate_signal(origin_msg_id);

        Self { id, code }
    }

    /// Convert [`SignalMessage`] into [`Message`].
    pub fn into_message(self, origin_msg_id: MessageId, destination: ProgramId) -> Message {
        Message::new(
            self.id,
            ProgramId::SYSTEM,
            destination,
            Default::default(),
            None,
            0,
            Some(SignalDetails::new(origin_msg_id, self.code).into()),
        )
    }

    /// Convert [`SignalMessage`] into [`Dispatch`].
    pub fn into_dispatch(self, origin_msg_id: MessageId, destination: ProgramId) -> Dispatch {
        Dispatch::new(
            DispatchKind::Signal,
            self.into_message(origin_msg_id, destination),
        )
    }

    /// Message id.
    pub fn id(&self) -> MessageId {
        self.id
    }

    /// Status code of the reply message.
    pub fn code(&self) -> SignalCode {
        self.code
    }
}