Skip to content

Commit 3a9e204

Browse files
authored
docs(request-response): document default message size limits
Fixes #5383 Pull-Request: #5922.
1 parent 4df989c commit 3a9e204

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

protocols/request-response/src/cbor.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@
2121
/// A request-response behaviour using [`cbor4ii::serde`] for serializing and
2222
/// deserializing the messages.
2323
///
24+
/// # Default Size Limits
25+
///
26+
/// The codec uses the following default size limits:
27+
/// - Maximum request size: 1,048,576 bytes (1 MiB)
28+
/// - Maximum response size: 10,485,760 bytes (10 MiB)
29+
///
30+
/// These limits can be customized with [`codec::Codec::set_request_size_maximum`]
31+
/// and [`codec::Codec::set_response_size_maximum`].
32+
///
2433
/// # Example
2534
///
2635
/// ```

protocols/request-response/src/json.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,15 @@
2121
/// A request-response behaviour using [`serde_json`] for serializing and deserializing the
2222
/// messages.
2323
///
24+
/// # Default Size Limits
25+
///
26+
/// The codec uses the following default size limits:
27+
/// - Maximum request size: 1,048,576 bytes (1 MiB)
28+
/// - Maximum response size: 10,485,760 bytes (10 MiB)
29+
///
30+
/// These limits can be customized with [`codec::Codec::set_request_size_maximum`]
31+
/// and [`codec::Codec::set_response_size_maximum`].
32+
///
2433
/// # Example
2534
///
2635
/// ```

0 commit comments

Comments
 (0)