#protocols #error #macro #binary #io-error #helper #enums

macro netgauze-serde-macros

Helper macros to make ser/deser binary protocols easier

3 releases (breaking)

0.3.0 Jan 31, 2024
0.2.0 Oct 9, 2023
0.1.0 Mar 5, 2023

#47 in #io-error

Download history 17/week @ 2024-03-11 10/week @ 2024-03-18 18/week @ 2024-03-25 89/week @ 2024-04-01 5/week @ 2024-04-08 10/week @ 2024-04-15 9/week @ 2024-04-22 9/week @ 2024-04-29 12/week @ 2024-05-06 2/week @ 2024-05-13 26/week @ 2024-05-20 23/week @ 2024-05-27 22/week @ 2024-06-03 22/week @ 2024-06-10 20/week @ 2024-06-17 24/week @ 2024-06-24

89 downloads per month
Used in 3 crates

Apache-2.0

22KB
336 lines

Helper macros to make ser/deser binary protocols easier

LocatedError: For a given error enum {Name} generate a struct called Located{Name} that carries the Span (the error location in the input stream) info along the error. Additionally, generates From for nom library errors, external, and another located errors.

use netgauze_serde_macros::LocatedError;

#[derive(LocatedError, Eq, PartialEq, Clone, Debug)]
pub enum ExtendedCommunityParsingError {
    NomError(#[from_nom] nom::error::ErrorKind),
    CommunityError(#[from_located(module = "self")] CommunityParsingError),
    UndefinedCapabilityCode(#[from_external] UndefinedBgpCapabilityCode),
}

#[derive(LocatedError, Eq, PartialEq, Clone, Debug)]
pub enum CommunityParsingError {
    NomError(#[from_nom] nom::error::ErrorKind),
}

#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct UndefinedBgpCapabilityCode(pub u8);

fn test() {
    let span = Span::new(&[1, 2, 3]);
    // LocatedExtendedCommunityParsingError is generated by LocatedError
    let _located = LocatedExtendedCommunityParsingError::new(
        span,
        ExtendedCommunityParsingError::UndefinedCapabilityCode(UndefinedBgpCapabilityCode(1)));
}

WritingError: Decorate an enum as an error for serializing binary protocol provides the following decorations for any members of the enum.

  1. #[from_std_io_error] automatically generate From implementation from std::io::Error to a String.
  2. #[from], automatically generates a From implementation for a given type.

Example:

use netgauze_serde_macros::WritingError;

#[derive(WritingError, Eq, PartialEq, Clone, Debug)]
pub enum BgpMessageWritingError {
    /// std::io::Error will be converted to this value
    StdIOError(#[from_std_io_error] String),

    /// BgpOpenMessageWritingError will be converted to this value
    OpenError(#[from] BgpOpenMessageWritingError),
}

Dependencies

~295–750KB
~18K SLoC