nodecraft 0.9.1

Crafting seamless node operations for distributed systems, which provides foundational traits for node identification and address resolution.
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

use std::future::Future;

use crate::Address;

mod impls;
use cheap_clone::CheapClone;
pub use impls::*;

#[cfg(feature = "agnostic")]
pub use agnostic::{Runtime, RuntimeLite};

#[cfg(not(feature = "agnostic"))]
/// Used to resolve a [`SocketAddr`] from a node address in async style.
pub trait AddressResolver: Send + Sync + 'static {
  /// The address type used to identify nodes.
  type Address: Address;
  /// The address type returned by the resolver.
  type ResolvedAddress: CheapClone
    + core::hash::Hash
    + Eq
    + core::fmt::Debug
    + core::fmt::Display
    + Send
    + Sync
    + 'static;
  /// The error type returned by the resolver.
  type Error: core::error::Error + Send + Sync + 'static;

  /// The options type used to configure the resolver.
  type Options: Send + Sync + 'static;

  /// Creates a new resolver with the given options.
  fn new(options: Self::Options) -> impl Future<Output = Result<Self, Self::Error>> + Send
  where
    Self: Sized;

  /// Resolves the given node address to a [`SocketAddr`].
  fn resolve(
    &self,
    address: &Self::Address,
  ) -> impl Future<Output = Result<Self::ResolvedAddress, Self::Error>> + Send;
}

#[cfg(feature = "agnostic")]
/// Used to resolve a [`SocketAddr`] from a node address in async style.
pub trait AddressResolver: Send + Sync + 'static {
  /// The address type used to identify nodes.
  type Address: Address;

  /// The address type returned by the resolver.
  type ResolvedAddress: CheapClone
    + core::hash::Hash
    + Eq
    + Ord
    + core::fmt::Debug
    + core::fmt::Display
    + Send
    + Sync
    + 'static;

  /// The error type returned by the resolver.
  type Error: core::error::Error + Send + Sync + 'static;

  /// The runtime used to resolve the address.
  type Runtime: agnostic::RuntimeLite;

  /// The options type used to configure the resolver.
  type Options: Send + Sync + 'static;

  /// Creates a new resolver with the given options.
  fn new(options: Self::Options) -> impl Future<Output = Result<Self, Self::Error>> + Send
  where
    Self: Sized;

  /// Resolves the given node address to a [`SocketAddr`].
  fn resolve(
    &self,
    address: &Self::Address,
  ) -> impl Future<Output = Result<Self::ResolvedAddress, Self::Error>> + Send;
}