ruststream-sea-file 0.6.0

File and stdio stream implementation of the RustStream broker contract, built on sea-streamer.
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

//! The crate-level error type.

use std::error::Error as StdError;

/// Errors returned by the file and stdio transports.
///
/// One enum for the whole crate, variants by source, per the `RustStream` broker conventions.
/// The wrapped sources are boxed `std` errors so the public API does not leak the client's
/// error types.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum SeaFileError {
    /// Opening (or creating) the stream file, or attaching stdio, failed.
    #[error("stream connect error on '{target}': {source}")]
    Connect {
        /// The file path or `stdio`.
        target: String,
        /// The client's failure.
        #[source]
        source: Box<dyn StdError + Send + Sync>,
    },

    /// Opening a subscription failed.
    #[error("subscribe error on '{stream}': {source}")]
    Subscribe {
        /// The stream key the subscription targeted.
        stream: String,
        /// The client's failure.
        #[source]
        source: Box<dyn StdError + Send + Sync>,
    },

    /// The transport failed while receiving.
    #[error("receive error on '{stream}': {source}")]
    Receive {
        /// The stream key (or file) of the subscription.
        stream: String,
        /// The client's failure.
        #[source]
        source: Box<dyn StdError + Send + Sync>,
    },

    /// Publishing failed.
    #[error("publish error to '{stream}': {source}")]
    Publish {
        /// The stream key the message targeted.
        stream: String,
        /// The client's failure.
        #[source]
        source: Box<dyn StdError + Send + Sync>,
    },

    /// Repositioning failed.
    #[error("seek error on '{stream}': {source}")]
    Seek {
        /// The stream key of the subscription.
        stream: String,
        /// The client's failure.
        #[source]
        source: Box<dyn StdError + Send + Sync>,
    },

    /// The handle is used before `connect` filled the shared state, or after `shutdown`.
    #[error("stream transport is not connected")]
    NotConnected,

    /// A descriptor or payload is invalid for this transport.
    #[error("invalid descriptor: {0}")]
    Invalid(String),
}

/// Boxes a client error into the crate's `Box<dyn StdError>` source form.
pub(crate) fn box_err<E>(err: E) -> Box<dyn StdError + Send + Sync>
where
    E: StdError + Send + Sync + 'static,
{
    Box::new(err)
}