File 2883-snmp-Types-and-specs-for-snmp_pdus-enc_mes... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2883-snmp-Types-and-specs-for-snmp_pdus-enc_message-1.patch of Package erlang

From d622c14f31e9e446a82a46e87bc65aae13efb13a Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Tue, 16 Jan 2024 11:08:38 +0100
Subject: [PATCH 63/67] [snmp] Types and specs for snmp_pdus:enc_message/1

---
 lib/snmp/doc/src/snmp_pdus.xml  | 6 ++----
 lib/snmp/src/misc/snmp_pdus.erl | 7 +++++++
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/lib/snmp/doc/src/snmp_pdus.xml b/lib/snmp/doc/src/snmp_pdus.xml
index 88c4ef2ca4..17ada0b02f 100644
--- a/lib/snmp/doc/src/snmp_pdus.xml
+++ b/lib/snmp/doc/src/snmp_pdus.xml
@@ -173,12 +173,10 @@
         <p>Decodes a list of bytes into an SNMP UsmSecurityParameters. </p>
       </desc>
     </func>
+
     <func>
-      <name since="">enc_message(Message) -> [byte()]</name>
+      <name name="enc_message" arity="1" clause_i="1" since=""/>
       <fsummary>Encode an SNMP Message</fsummary>
-      <type>
-        <v>Message = #message</v>
-      </type>
       <desc>
         <p>Encodes a message record to a list of bytes.</p>
       </desc>
diff --git a/lib/snmp/src/misc/snmp_pdus.erl b/lib/snmp/src/misc/snmp_pdus.erl
index eeb0754d4e..8c490024b7 100644
--- a/lib/snmp/src/misc/snmp_pdus.erl
+++ b/lib/snmp/src/misc/snmp_pdus.erl
@@ -534,11 +534,13 @@ dec_integer_len([A,B,C]) ->
 dec_integer_len([0 | T]) ->
     dec_integer_len(T).
 
+
 %%-----------------------------------------------------------------
 %% head(N, List) -> {List1, List2}
 %%   List == List1 ++ List2
 %%   length(List1) == N
 %%-----------------------------------------------------------------
+
 head(L,List) ->
     head(L,List,[]).
 
@@ -550,10 +552,15 @@ head(Int,[H|Tail],Res) ->
 head(Int, [], _Res) ->
     exit({asn1_error, {bad_length, Int}}).
 
+
 %%%----------------------------------------------------------------------
 %%% ENCODING ENCODING ENCODING ENCODING ENCODING ENCODING ENCODING ENCODING 
 %%%----------------------------------------------------------------------
 
+-spec enc_message(Message) -> Bytes when
+      Message :: message(),
+      Bytes   :: [byte()].
+
 enc_message(#message{version = Ver, vsn_hdr = VsnHdr, data = Data}) ->
     VerBytes = enc_version(Ver),
     Bytes = 
-- 
2.35.3

Places

File 2883-snmp-Types-and-specs-for-snmp_pdus-enc_message-1.patch of Package erlang

Places