docs(irtt-proto): add runnable doctests for public API
Add executable doctests documenting the consumer-facing contract of irtt-proto: the directional request encode/decode/verify split, Params construction and round-trip, omitted-vs-explicit-zero presence, open and echo reply round trips, packet length calculation, and HMAC verification. No conventional tests are migrated: every existing irtt-proto test exercises wire vectors, flag matrices, malformed input, layout rules, HMAC error behavior, or encode/decode round trips, which the crate's AGENTS.md treats as durable compatibility coverage rather than documentation cleanup targets.
This commit is contained in:
8 files changed
+236
No files matched your search
@@ -88,6 +88,26 @@ pub enum DecodedRequestKind<'a> {
|
||||
/// the negotiated length is positive and wider than `usize`. A *negative*
|
||||
/// negotiated length is not an error: see [`echo_packet_len`], which floors it
|
||||
/// at the mandatory field block.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// use irtt_proto::{encode_request, Params, RequestToEncode};
|
||||
///
|
||||
/// // An unauthenticated ECHO probe. `params` supplies the negotiated length,
|
||||
/// // which reserves four payload bytes beyond the 16-byte echo header.
|
||||
/// let params = Params { length: 20, ..Params::default() };
|
||||
/// let packet = encode_request(
|
||||
/// RequestToEncode::Echo {
|
||||
/// token: 0x1234_5678_9abc_def0,
|
||||
/// sequence: 7,
|
||||
/// params: ¶ms,
|
||||
/// payload: &[1, 2, 3, 4],
|
||||
/// },
|
||||
/// None,
|
||||
/// ).unwrap();
|
||||
/// assert_eq!(packet.len(), 20);
|
||||
/// ```
|
||||
pub fn encode_request(request: RequestToEncode<'_>, hmac_key: Option<&[u8]>) -> Result<Vec<u8>> {
|
||||
match request {
|
||||
RequestToEncode::Open { params, no_test } => encode_open(params, no_test, hmac_key),
|
||||
@@ -138,6 +158,21 @@ pub fn encode_request(request: RequestToEncode<'_>, hmac_key: Option<&[u8]>) ->
|
||||
/// Returns [`ProtoError::PacketTooShort`], [`ProtoError::BadMagic`],
|
||||
/// [`ProtoError::ReservedFlags`], or [`ProtoError::UnexpectedFlag`] for
|
||||
/// `FLAG_REPLY`.
|
||||
///
|
||||
/// # Example
|
||||
///
|
||||
/// ```
|
||||
/// use irtt_proto::{decode_request, encode_request, DecodedRequestKind, RequestToEncode};
|
||||
///
|
||||
/// let packet = encode_request(
|
||||
/// RequestToEncode::Close { token: 0x1234_5678_9abc_def0 },
|
||||
/// None,
|
||||
/// ).unwrap();
|
||||
///
|
||||
/// let request = decode_request(&packet).unwrap();
|
||||
/// assert!(!request.hmac_present);
|
||||
/// assert_eq!(request.kind, DecodedRequestKind::Close { token: 0x1234_5678_9abc_def0 });
|
||||
/// ```
|
||||
pub fn decode_request(packet: &[u8]) -> Result<DecodedRequest<'_>> {
|
||||
let envelope = envelope::decode_structural(packet)?;
|
||||
if has(envelope.flags, FLAG_REPLY) {
|
||||
|
||||
Reference in new issue
Block a user