Skip to content

Commit 8d4df82

Browse files
committed
Add decode to readme
1 parent 880d806 commit 8d4df82

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

ber.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ local function decode(value, cursor, maxDepth)
205205
return {
206206
class = class,
207207
constructed = constructed,
208-
tag = tag,
208+
type = tag,
209209
length = length,
210210
data = data,
211211
children = children,

readme.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ The BerObject:
2222

2323
### Encode
2424

25+
Functions:
26+
```lua
27+
ber.identifier(options) -- BerObject (without data and length)
28+
ber.length(value) -- number (generates octet for indefinite form if nil)
29+
ber.encode(value) -- BerObject
30+
```
31+
2532
Generate the identifier octets:
2633
```lua
2734
local result = ber.identifier {
@@ -93,3 +100,24 @@ assert(ber.encode(obj) == ber.encode "Hello Steve")
93100

94101
### Decode
95102

103+
Functions:
104+
```lua
105+
ber.decode(
106+
value, -- BER data as string
107+
start, -- Start index (default: 1)
108+
recursionDepth -- Max recursion depth for deconstruction (default: math.maxinteger)
109+
)
110+
```
111+
112+
`decode` always returns a BerObject:
113+
114+
```lua
115+
assert(ber.decode(ber.encode "Hello") == {
116+
class = 0,
117+
constructed = false,
118+
type = 4,
119+
length = 5,
120+
data = "Hello",
121+
children = nil
122+
})
123+
```

0 commit comments

Comments
 (0)