gtest 1.5.1

Testing utils for developing Gear programs.
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

// This file is part of Gear.

// Copyright (C) 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/>.

//! Mailbox manager.

use crate::blocks::BlocksManager;
use gear_common::{
    auxiliary::mailbox::*,
    storage::{GetCallback, Interval, IterableByKeyMap, Mailbox, MailboxCallbacks},
};
use gear_core::ids::{MessageId, ProgramId};

/// Mailbox manager which operates under the hood over
/// [`gear_common::AuxiliaryMailbox`].
#[derive(Debug, Default)]
pub(crate) struct MailboxManager;

impl MailboxManager {
    /// Insert user message into mailbox.
    pub(crate) fn insert(&self, message: MailboxedMessage) -> Result<(), MailboxErrorImpl> {
        <AuxiliaryMailbox<MailboxCallbacksImpl> as Mailbox>::insert(message, u32::MAX)
    }

    /// Remove user message from mailbox.
    pub(crate) fn remove(
        &self,
        user: ProgramId,
        reply_to: MessageId,
    ) -> Result<(MailboxedMessage, Interval<BlockNumber>), MailboxErrorImpl> {
        <AuxiliaryMailbox<MailboxCallbacksImpl> as Mailbox>::remove(user, reply_to)
    }

    /// Returns an iterator over all `to` user messages and their deadlines
    /// inside mailbox.
    pub(crate) fn iter_key(
        &self,
        to: ProgramId,
    ) -> impl Iterator<Item = (MailboxedMessage, Interval<BlockNumber>)> {
        <AuxiliaryMailbox<MailboxCallbacksImpl> as IterableByKeyMap<_>>::iter_key(to)
    }

    /// Fully reset mailbox.
    ///
    /// # Note:
    /// Must be called by `MailboxManager` owner to reset mailbox
    /// when the owner is dropped.
    pub(crate) fn reset(&self) {
        <AuxiliaryMailbox<MailboxCallbacksImpl> as Mailbox>::clear();
    }
}

/// Mailbox callbacks implementor.
pub(crate) struct MailboxCallbacksImpl;

impl MailboxCallbacks<MailboxErrorImpl> for MailboxCallbacksImpl {
    type Value = MailboxedMessage;
    type BlockNumber = BlockNumber;

    type GetBlockNumber = GetBlockNumberImpl;

    type OnInsert = ();
    type OnRemove = ();
}

/// Block number getter.
///
/// Used to get block number to insert message into mailbox.
pub(crate) struct GetBlockNumberImpl;

impl GetCallback<BlockNumber> for GetBlockNumberImpl {
    fn call() -> BlockNumber {
        BlocksManager::new().get().height
    }
}