gstd 1.10.0

Gear programs standard library
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

// This file is part of Gear.

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

macro_rules! impl_futures {
    ($f:ident, $r:ty, |$fut:ident, $cx:ident| => { $p:expr }) => {
        impl_futures!($f, $r, ($fut, $cx), $p, );
    };
    ($f:ident, $g: tt, $r:ty, |$fut:ident, $cx:ident| => { $p:expr }) => {
        impl_futures!($f, $r, ($fut, $cx), $p, $g);
    };
    ($f:ident, $r:ty, ($fut:ident, $cx:ident), $p:expr, $($g:tt)?) => {
        impl $( <$g: Decode> )? FusedFuture for $f $( < $g > )? {
            fn is_terminated(&self) -> bool {
                !signals().waits_for(self.waiting_reply_to)
            }
        }

        impl $( <$g: Decode> )? Future for $f $( < $g > )? {
            type Output = Result<$r>;

            fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
                let $fut = &mut self;
                let $cx = cx;

                $p
            }
        }

        impl $( <$g: Decode> )? $f $( < $g > )? {
            /// Postpone handling for a maximum amount of blocks that could be paid, that
            /// doesn't exceed a given duration.
            pub fn up_to(self, duration: Option<u32>) -> Result<Self> {
                async_runtime::locks().lock(
                    crate::msg::id(),
                    self.waiting_reply_to,
                    Lock::up_to(duration.unwrap_or(Config::wait_up_to()))?,
                );

                Ok(self)
            }

            /// Postpone handling for a given specific amount of blocks.
            pub fn exactly(self, duration: Option<u32>) -> Result<Self> {
                async_runtime::locks().lock(
                    crate::msg::id(),
                    self.waiting_reply_to,
                    Lock::exactly(duration.unwrap_or(Config::wait_for()))?,
                );

                Ok(self)
            }

            /// Execute a function when the reply is received.
            ///
            /// This callback will be executed in reply context and consume reply gas, so
            /// adequate `reply_deposit` should be supplied in `*_for_reply` call
            /// that comes before this. Note that the hook will still be executed on reply
            /// even after original future resolves in timeout.
            ///
            /// # Examples
            ///
            /// Send message to echo program and wait for reply.
            ///
            /// ```
            /// use gstd::{ActorId, msg, debug};
            ///
            /// #[gstd::async_main]
            /// async fn main() {
            ///     let dest = ActorId::from(1); // Replace with correct actor id
            ///
            ///     msg::send_bytes_for_reply(dest, b"PING", 0, 1_000_000)
            ///         .expect("Unable to send")
            ///         .handle_reply(|| {
            ///             debug!("reply code: {:?}", msg::reply_code());
            ///
            ///             if msg::load_bytes().unwrap_or_default() == b"PONG" {
            ///                debug!("successfully received pong");
            ///             }
            ///         })
            ///         .expect("Error setting reply hook")
            ///         .await
            ///         .expect("Received error");
            /// }
            /// # fn main() {}
            /// ```
            ///
            /// # Panics
            ///
            /// Panics if this is called second time.
            #[cfg(not(feature = "ethexe"))]
            pub fn handle_reply<F: FnOnce() + 'static>(self, f: F) -> Result<Self> {
                if self.reply_deposit == 0 {
                    return Err(Error::Gstd(crate::errors::UsageError::ZeroReplyDeposit));
                }
                async_runtime::reply_hooks().register(self.waiting_reply_to.clone(), f);

                Ok(self)
            }
        }
    };
}