doc/userguide: improve SCStreamingBuffer example

Add direction indication in SCStreamingBuffer usage example. This adds documentation for the changes introduced by commit 5b1d8c7.
OISF · Jul 28, 2023 · 15ad513 · 15ad513
1 parent 8770431
commit 15ad513
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/doc/userguide/lua/lua-functions.rst b/doc/userguide/lua/lua-functions.rst
@@ -960,7 +960,13 @@ SCStreamingBuffer
 ::
 
   function log(args)
-      data = SCStreamingBuffer()
+      -- sb_ts and sb_tc are bools indicating the direction of the data
+      data, sb_open, sb_close, sb_ts, sb_tc = SCStreamingBuffer()
+      if sb_ts then
+        print("->")
+      else
+        print("<-")
+      end
       hex_dump(data)
   end