From ee8fef6743a8b0803c84b489975dbe05aff2b127 Mon Sep 17 00:00:00 2001 From: chantra Date: Tue, 9 Feb 2021 22:41:26 -0800 Subject: [PATCH] Update Truncate doc with compress behaviour (#1217) * Update Truncate doc with compress behaviour This is a documentation update to highlight the behaviour of Truncate, which will reset dns.Compress to false when the message fits in the requested size without truncation, and make it the caller responsibility to set it back to true if they wish to compress, regardless of fitting, uncompressed, in the requested message size in the first place or not. Fixes #1216 * address comments * d/Note that/ * s/reset/set/ * s/caller/caller's/ * removed backticks * regardless of size --- msg_truncate.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/msg_truncate.go b/msg_truncate.go index 156c5a0e..2ddc9a7d 100644 --- a/msg_truncate.go +++ b/msg_truncate.go @@ -8,6 +8,11 @@ package dns // record adding as many records as possible without exceeding the // requested buffer size. // +// If the message fits within the requested size without compression, +// Truncate will set the message's Compress attribute to false. It is +// the caller's responsibility to set it back to true if they wish to +// compress the payload regardless of size. +// // The TC bit will be set if any records were excluded from the message. // If the TC bit is already set on the message it will be retained. // TC indicates that the client should retry over TCP.