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

//!
//! Protofish is a decoder focused on decoding arbitrary protocol buffer messages
//! with error recovery. Its primary use case is decoding gRPC mesages in
//! [proxide](https://github.com/Rantanen/proxide) based on .proto-files supplied
//! by the user at runtime.
//!
//!
//! ```
//! use protofish::{Context, Value, UnknownValue};
//! use bytes::Bytes;
//!
//! let context = Context::parse(&[r#"
//!   syntax = "proto3";
//!   package Proto;
//!
//!   message Request { string kind = 1; }
//!   message Response { int32 distance = 1; }
//!   service Fish {
//!     rpc Swim( Request ) returns ( Response );
//!   }
//! "#]).unwrap();
//!
//! let service = context.get_service("Proto.Fish").unwrap();
//! let rpc = service.rpc_by_name("Swim").unwrap();
//!
//! let input = rpc.input.message.decode(b"\x0a\x05Perch", &context);
//! assert_eq!(input.fields[0].number, 1);
//! assert_eq!(input.fields[0].value, Value::String(String::from("Perch")));
//!
//! let output = rpc.output.message.decode(b"\x08\xa9\x46", &context);
//! assert_eq!(output.fields[0].number, 1);
//! assert_eq!(output.fields[0].value, Value::Int32(9001));
//!
//! let request = context.get_message("Proto.Request").unwrap();
//! let value = request.decode(b"\x12\x07Unknown\x0a\x0fAtlantic ", &context);
//! assert_eq!(value.fields[0].number, 2);
//! assert_eq!(
//!     value.fields[0].value,
//!     Value::Unknown(UnknownValue::VariableLength(Bytes::from_static(b"Unknown"))));
//! assert_eq!(
//!     value.fields[1].value,
//!     Value::Incomplete(Bytes::from_static(b"\x0fAtlantic ")));
//! ```
#![warn(missing_docs)]
#![allow(clippy::match_bool)]

pub mod context;
pub mod decode;

pub use crate::context::{Context, Error, MessageInfo, Result};
pub use crate::decode::{EnumValue, MessageValue, UnknownValue, Value};