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
21
22
23
24
25
26
27
28
29
30
31
32

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 (de-)serializing messages.
#[derive(Debug, Error)]
pub enum Error {
    /// An error during reflection.
    #[error(transparent)]
    Reflect(#[from] facet::ReflectError),

    /// The string was misencoded.
    #[error("unable to decode string: {0}")]
    Encoding(#[from] crate::wire::upcode::DecodeError),

    /// The message didn't include a tag.
    #[error("no message tag found")]
    MissingTag,

    /// The message didn't include required tag.
    #[error("message tag didn't match struct tag")]
    MismatchedTag,

    /// The message didn't include the required value.
    #[error("expected value, but input is exhausted")]
    MissingValue,

    /// The format of the map wasn't respected.
    #[error("expected a format with <key>=<value>")]
    MisformatedMap,
}