oxiproto-core 0.1.2

Pure Rust protobuf core types
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

//! `oxiproto-core` — Pure Rust protobuf core types.
//!
//! Provides re-exports of the fundamental [`prost`] traits and error types
//! used across the OxiProto stack, plus native wire format primitives in the
//! [`wire`] module.
//!
//! ## Wire Format
//!
//! The [`wire`] module provides a complete, standalone implementation of the
//! protobuf binary wire format:
//!
//! - Varint (LEB128) encoding/decoding
//! - ZigZag encoding for signed integers
//! - Field tag encoding/decoding
//! - Fixed 32/64-bit little-endian encoding
//! - Length-delimited fields (strings, bytes, embedded messages)
//! - [`DecodeBuffer`](wire::DecodeBuffer) / [`EncodeBuffer`](wire::EncodeBuffer)
//!   for streaming encode/decode
//! - [`UnknownFields`](wire::UnknownFields) for preserving unrecognized fields

#![forbid(unsafe_code)]
#![cfg_attr(not(feature = "std"), no_std)]
#[cfg(not(feature = "std"))]
extern crate alloc;

pub mod wire;

pub mod arena;
pub mod extensions;
pub mod message;
pub mod name;
pub mod oneof;
pub mod reflect_bridge;

pub use prost::Message;
pub use prost::Name;
pub use prost_types;

pub use extensions::Extensions;
pub use message::OxiMessage;
pub use name::OxiName;
pub use oneof::OxiOneof;

/// Convenience type alias for `Result<T, OxiProtoError>`.
pub type OxiProtoResult<T> = Result<T, OxiProtoError>;

/// Errors produced by the OxiProto stack.
#[derive(Debug)]
#[non_exhaustive]
pub enum OxiProtoError {
    /// A `.proto` source file could not be parsed or resolved.
    ParseError(prost::alloc::string::String),
    /// Rust code could not be generated from the parsed descriptors.
    CodegenError(prost::alloc::string::String),
    /// An underlying I/O operation failed.
    #[cfg(feature = "std")]
    IoError(std::io::Error),
    /// A wire format encoding or decoding error.
    WireFormatError(wire::WireError),
}

impl core::fmt::Display for OxiProtoError {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        match self {
            OxiProtoError::ParseError(s) => write!(f, "proto parse error: {s}"),
            OxiProtoError::CodegenError(s) => write!(f, "proto codegen error: {s}"),
            #[cfg(feature = "std")]
            OxiProtoError::IoError(e) => write!(f, "I/O error: {e}"),
            OxiProtoError::WireFormatError(e) => write!(f, "wire format error: {e}"),
        }
    }
}

impl core::error::Error for OxiProtoError {
    fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
        match self {
            #[cfg(feature = "std")]
            OxiProtoError::IoError(e) => Some(e),
            OxiProtoError::WireFormatError(e) => Some(e),
            OxiProtoError::ParseError(_) | OxiProtoError::CodegenError(_) => None,
        }
    }
}

#[cfg(feature = "std")]
impl From<std::io::Error> for OxiProtoError {
    fn from(e: std::io::Error) -> Self {
        OxiProtoError::IoError(e)
    }
}

impl From<wire::WireError> for OxiProtoError {
    fn from(e: wire::WireError) -> Self {
        OxiProtoError::WireFormatError(e)
    }
}