nostr-sdk 0.45.0

A full-featured SDK for building high-performance and reliable nostr applications.
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

// Copyright (c) 2022-2023 Yuki Kishimoto
// Copyright (c) 2023-2025 Rust Nostr Developers
// Distributed under the MIT software license

use std::collections::HashMap;
use std::ops::{Deref, DerefMut};

use nostr::event::EventId;
use nostr::message::SubscriptionId;
use nostr::types::RelayUrl;

/// Output
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct Output<T, S = (), F = String> {
    /// The output value
    pub value: T,
    /// Successful relays and their operation-specific output.
    pub success: HashMap<RelayUrl, S>,
    /// Map of relays that failed with related errors.
    pub failed: HashMap<RelayUrl, F>,
}

impl<T, S, F> Deref for Output<T, S, F> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.value
    }
}

impl<T, S, F> DerefMut for Output<T, S, F> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.value
    }
}

impl<T, S, F> Output<T, S, F> {
    /// Create a new output
    #[inline]
    #[must_use]
    pub fn new(value: T) -> Self {
        Self {
            value,
            success: HashMap::new(),
            failed: HashMap::new(),
        }
    }
}

impl<S, F> Output<EventId, S, F> {
    /// Get event ID
    #[inline]
    #[must_use]
    pub fn id(&self) -> &EventId {
        self.deref()
    }
}

impl<S, F> Output<SubscriptionId, S, F> {
    /// Get subscription ID
    #[inline]
    #[must_use]
    pub fn id(&self) -> &SubscriptionId {
        self.deref()
    }
}