yengine 0.0.8

Communication library for the Yate Engine external module protocol.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

use thiserror::Error;

/// A handy [`std::fmt::Result`] alias with the [`enum@Error`] type.
pub type Result<T, E = Error> = std::result::Result<T, E>;

/// An error that may occur when interracting with the engine.
#[derive(Debug, Error)]
pub enum Error {
    /// An I/O error occured.
    #[error("I/O error: {0}")]
    Io(#[from] std::io::Error),

    /// An error occured while (de)-serializing messages.
    #[error("format error: {0}")]
    Format(#[from] crate::wire::Error),

    /// The data stream was closed before expected.
    #[error("got an unexpected end of stream from engine")]
    UnexpectedEof,
}