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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

// Smoldot
// Copyright (C) 2024  Pierre Krieger
// 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 <http://www.gnu.org/licenses/>.

use core::{iter, pin::Pin};

use super::{Address, ConnectionType, LogLevel, MultiStreamAddress, PlatformRef};
use alloc::{borrow::Cow, format, string::String};

/// Implementation of a [`PlatformRef`] that wraps around another platform and adds a prefix
/// before every log line and task name.
#[derive(Debug, Clone)]
pub struct WithPrefix<T> {
    inner: T,
    prefix: String,
}

impl<T> WithPrefix<T> {
    /// Builds a new [`WithPrefix`].
    pub const fn new(prefix: String, inner: T) -> Self {
        WithPrefix { inner, prefix }
    }
}

impl<T: PlatformRef> PlatformRef for WithPrefix<T> {
    type Delay = T::Delay;
    type Instant = T::Instant;
    type MultiStream = T::MultiStream;
    type Stream = T::Stream;
    type ReadWriteAccess<'a> = T::ReadWriteAccess<'a>;
    type StreamErrorRef<'a> = T::StreamErrorRef<'a>;
    type StreamConnectFuture = T::StreamConnectFuture;
    type MultiStreamConnectFuture = T::MultiStreamConnectFuture;
    type StreamUpdateFuture<'a> = T::StreamUpdateFuture<'a>;
    type NextSubstreamFuture<'a> = T::NextSubstreamFuture<'a>;

    fn now_from_unix_epoch(&self) -> core::time::Duration {
        self.inner.now_from_unix_epoch()
    }

    fn now(&self) -> Self::Instant {
        self.inner.now()
    }

    fn fill_random_bytes(&self, buffer: &mut [u8]) {
        self.inner.fill_random_bytes(buffer)
    }

    fn sleep(&self, duration: core::time::Duration) -> Self::Delay {
        self.inner.sleep(duration)
    }

    fn sleep_until(&self, when: Self::Instant) -> Self::Delay {
        self.inner.sleep_until(when)
    }

    fn spawn_task(
        &self,
        task_name: Cow<str>,
        task: impl futures_util::future::Future<Output = ()> + Send + 'static,
    ) {
        self.inner
            .spawn_task(Cow::Owned(format!("{}-{}", self.prefix, task_name)), task)
    }

    fn log<'a>(
        &self,
        log_level: LogLevel,
        log_target: &'a str,
        message: &'a str,
        mut key_values: impl Iterator<Item = (&'a str, &'a dyn core::fmt::Display)>,
    ) {
        self.inner.log(
            log_level,
            &format!("{}-{}", self.prefix, log_target),
            message,
            // We have to use `iter::from_fn` due to a lifetime mismatch between the items
            // produced by the iterator and the newly-constructed log target.
            iter::from_fn(move || key_values.next()),
        )
    }

    fn client_name(&self) -> Cow<str> {
        self.inner.client_name()
    }

    fn client_version(&self) -> Cow<str> {
        self.inner.client_version()
    }

    fn supports_connection_type(&self, connection_type: ConnectionType) -> bool {
        self.inner.supports_connection_type(connection_type)
    }

    fn connect_stream(&self, address: Address) -> Self::StreamConnectFuture {
        self.inner.connect_stream(address)
    }

    fn connect_multistream(&self, address: MultiStreamAddress) -> Self::MultiStreamConnectFuture {
        self.inner.connect_multistream(address)
    }

    fn open_out_substream(&self, connection: &mut Self::MultiStream) {
        self.inner.open_out_substream(connection)
    }

    fn next_substream<'a>(
        &self,
        connection: &'a mut Self::MultiStream,
    ) -> Self::NextSubstreamFuture<'a> {
        self.inner.next_substream(connection)
    }

    fn read_write_access<'a>(
        &self,
        stream: Pin<&'a mut Self::Stream>,
    ) -> Result<Self::ReadWriteAccess<'a>, Self::StreamErrorRef<'a>> {
        self.inner.read_write_access(stream)
    }

    fn wait_read_write_again<'a>(
        &self,
        stream: Pin<&'a mut Self::Stream>,
    ) -> Self::StreamUpdateFuture<'a> {
        self.inner.wait_read_write_again(stream)
    }
}