shmipc 0.1.1

Shared memory IPC for Rust
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
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

// Copyright 2025 CloudWeGo Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::io;

#[derive(thiserror::Error, Debug)]
#[non_exhaustive]
pub enum Error {
    /// InvalidVersion means that we received a frame with an invalid version.
    #[error("invalid protocol version")]
    InvalidVersion,

    /// InvalidMsgType means that we received a frame with an invalid message type.
    #[error("invalid msg type")]
    InvalidMsgType,

    /// SessionShutdown is used if there is a shutdown during an operation.
    #[error("session shutdown")]
    SessionShutdown,

    /// StreamsExhausted is returned if we have no more stream ids to issue.
    #[error("streams exhausted")]
    StreamsExhausted,

    /// DuplicateStream is used if a duplicate stream is opened inbound.
    #[error("duplicate stream initiated")]
    DuplicateStream,

    /// Timeout is used when we reach an IO deadline.
    #[error("i/o deadline reached")]
    Timeout,

    /// StreamClosed is returned when using a closed stream.
    #[error("stream closed")]
    StreamClosed,

    /// StreamResetByPeer is returned when the peer reset the stream.
    #[error("stream reset by peer")]
    StreamReset,

    /// ConnectionWriteTimeout indicates that we hit the "safety valve" timeout writing to the
    /// underlying stream connection.
    #[error("connection write timeout")]
    ConnectionWriteTimeout,

    #[error("connection timeout")]
    ConnectionTimeout,

    /// KeepAliveTimeout is sent if a missed keepalive caused the stream close.
    #[error("keepalive timeout")]
    KeepAliveTimeout,

    /// EndOfStream means that the stream is end, user shouldn't read from the stream.
    #[error("end of stream")]
    EndOfStream,

    /// SessionUnhealthy occurred at `session.open_stream()`, which means that the session is
    /// overload.
    ///
    /// User should retry after 60 seconds, and the following situation will result in
    /// SessionUnhealthy.
    ///
    /// 1. When local share memory is not enough, client send request data via unix domain socket.
    ///
    /// 2. When peer share memory is not enough, client receive response data from unix domain
    ///    socket.
    #[error("now the session is unhealthy, please retry later")]
    SessionUnhealthy,

    /// NotEnoughData means that the real read size < expect read size.
    ///
    /// In general, which happened on application protocol is buffered.
    #[error("current buffer is not enough data to read")]
    NotEnoughData,

    /// NoMoreBuffer means that the share memory is busy, and no more buffer to allocate.
    #[error("share memory no more buffer")]
    NoMoreBuffer,

    /// SizeTooLarge means that the allocated size exceeded.
    #[error("alloc size exceed")]
    SizeTooLarge,

    /// BrokenBuffer means that the share memory's layout had broken, which happens in that the
    /// share memory was alter by external or internal bug.
    #[error("share memory's buffer had broken")]
    BrokenBuffer,

    #[error("share memory had not left space")]
    ShareMemoryHadNotLeftSpace,

    #[error("stream callbacks had existed")]
    StreamCallbackHadExisted,

    /// ExchangeConfig means message type error during exchange config phase.
    #[error("exchange config protocol invalid")]
    ExchangeConfig,

    /// ExchangeConfigTimeout means client exchange config timeout.
    #[error("exchange config timeout")]
    ExchangeConfigTimeout,

    #[error("shmipc just support linux OS now")]
    OSNonSupported,

    #[error("shmipc just support amd64 or arm64 arch")]
    ArchNonSupported,

    /// Ensure once hot restart succeed
    #[error("hot restart in progress, try again later")]
    HotRestartInProgress,

    #[error("session in handshake stage, try again later")]
    InHandshakeStage,

    /// File name max len 255
    #[error("share memory path prefix too long")]
    FileNameTooLong,

    #[error("the queue is empty")]
    QueueEmpty,

    #[error("the queue is full")]
    QueueFull,

    #[error("stream pool is full")]
    StreamPoolFull,

    #[error("stream had unread data, size: {0}")]
    StreamHasUnreadData(usize),

    #[error("stream had pending data, pending slice len: {0}")]
    StreamHasPendingData(usize),

    #[error(transparent)]
    Io(#[from] std::io::Error),

    #[error(transparent)]
    Others(#[from] anyhow::Error),
}

impl From<Error> for io::Error {
    fn from(value: Error) -> Self {
        match value {
            Error::InvalidVersion => io::Error::new(io::ErrorKind::InvalidData, value),
            Error::InvalidMsgType => io::Error::new(io::ErrorKind::InvalidData, value),
            Error::SessionShutdown => io::Error::new(io::ErrorKind::ConnectionReset, value),
            Error::StreamsExhausted => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::DuplicateStream => io::Error::new(io::ErrorKind::AlreadyExists, value),
            Error::Timeout => io::Error::new(io::ErrorKind::TimedOut, value),
            Error::StreamClosed => io::Error::new(io::ErrorKind::ConnectionAborted, value),
            Error::StreamReset => io::Error::new(io::ErrorKind::ConnectionReset, value),
            Error::ConnectionWriteTimeout => io::Error::new(io::ErrorKind::InvalidData, value),
            Error::ConnectionTimeout => io::Error::new(io::ErrorKind::TimedOut, value),
            Error::KeepAliveTimeout => io::Error::new(io::ErrorKind::TimedOut, value),
            Error::EndOfStream => io::Error::new(io::ErrorKind::UnexpectedEof, value),
            Error::SessionUnhealthy => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::NotEnoughData => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::NoMoreBuffer => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::SizeTooLarge => io::Error::new(io::ErrorKind::OutOfMemory, value),
            Error::BrokenBuffer => io::Error::new(io::ErrorKind::BrokenPipe, value),
            Error::ShareMemoryHadNotLeftSpace => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::StreamCallbackHadExisted => io::Error::new(io::ErrorKind::AlreadyExists, value),
            Error::ExchangeConfig => io::Error::other(value),
            Error::ExchangeConfigTimeout => io::Error::new(io::ErrorKind::TimedOut, value),
            Error::OSNonSupported => io::Error::new(io::ErrorKind::Unsupported, value),
            Error::ArchNonSupported => io::Error::new(io::ErrorKind::Unsupported, value),
            Error::HotRestartInProgress => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::InHandshakeStage => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::FileNameTooLong => io::Error::new(io::ErrorKind::InvalidInput, value),
            Error::QueueEmpty => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::QueueFull => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::StreamPoolFull => io::Error::new(io::ErrorKind::ResourceBusy, value),
            Error::StreamHasUnreadData(_) => io::Error::other(value),
            Error::StreamHasPendingData(_) => io::Error::other(value),
            Error::Io(io) => io,
            Error::Others(err) => io::Error::other(err),
        }
    }
}