dsf-core 0.2.0

DSF core object definitions
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

//! API module defines the DSF remote API
//! This allows for limited capability devices to perform network operations via
//! a full-featured device

use crate::types::Id;

/// ServiceHandle objects are used to pass around instances of a service
#[derive(Debug, Clone, PartialEq)]
pub struct ServiceHandle {
    pub id: Id,
}

impl ServiceHandle {
    pub fn new(id: Id) -> Self {
        Self { id }
    }
}

/// Creation API used to create services
pub trait Create {
    type Options;
    type Error;

    /// Create a new service with the provided options
    fn create(&mut self, options: Self::Options) -> Result<ServiceHandle, Self::Error>;
}

/// Producer API trait used to register an existing service
pub trait Register {
    type Options;
    type Info;
    type Error;

    /// Register a service in the distributed database
    fn register(&mut self, options: Self::Options) -> Result<Self::Info, Self::Error>;
}

/// Locate API trait used to find an existing service
pub trait Locate {
    type Options;
    type Info;
    type Error;

    /// Locate a DIoT service in the distributed database
    /// This returns a future that will resolve to the desired service or an error
    fn locate(&mut self, options: Self::Options) -> Result<Self::Info, Self::Error>;
}

/// Publisher API trait used by publishers of service data
pub trait Publish {
    type Options;
    type Info;
    type Error;

    /// Publish service data
    fn publish(&mut self, options: Self::Options) -> Result<Self::Info, Self::Error>;
}

/// A boxed future stream to shorten method definitions
/// //pub type FutureStream<E> = impl Stream<Item=E>;

/// Subscriber API used by subscribers to service data
pub trait Subscribe {
    type Options;
    type Streamable;
    type Error;

    /// Locate a DIoT service in the distributed database
    /// This returns a future that will resolve to the desired service or an error
    fn subscribe(&mut self, options: Self::Options) -> Result<Self::Streamable, Self::Error>;
}