From 272d83c4309b68838a139b6288bb94d166ffd7b1 Mon Sep 17 00:00:00 2001 From: Daniel Abramov Date: Sun, 29 Oct 2023 14:09:32 +0100 Subject: [PATCH] doc: clarify the meaning of config values --- src/protocol/mod.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/protocol/mod.rs b/src/protocol/mod.rs index 962904d..dd8e279 100644 --- a/src/protocol/mod.rs +++ b/src/protocol/mod.rs @@ -58,11 +58,11 @@ pub struct WebSocketConfig { /// Note: Should always be at least [`write_buffer_size + 1 message`](Self::write_buffer_size) /// and probably a little more depending on error handling strategy. pub max_write_buffer_size: usize, - /// The maximum size of a message. `None` means no size limit. The default value is 64 MiB + /// The maximum size of an incoming message. `None` means no size limit. The default value is 64 MiB /// which should be reasonably big for all normal use-cases but small enough to prevent /// memory eating by a malicious user. pub max_message_size: Option, - /// The maximum size of a single message frame. `None` means no size limit. The limit is for + /// The maximum size of a single incoming message frame. `None` means no size limit. The limit is for /// frame payload NOT including the frame header. The default value is 16 MiB which should /// be reasonably big for all normal use-cases but small enough to prevent memory eating /// by a malicious user.