Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

byteutils: openArray[char] version of toBytes #210

Merged
merged 1 commit into from
Nov 14, 2023
Merged

byteutils: openArray[char] version of toBytes #210

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions stew/byteutils.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,17 +237,17 @@ func to0xHex*[N: static[int]](ba: array[N, byte]): string {.inline.} =
## No "endianness" reordering is done.
toHexAux(ba, true)

func toBytes*(s: openArray[char]): seq[byte] =
## Convert a char array to the corresponding byte sequence - since strings in
## nim essentially are byte sequences without any particular encoding, this
## simply copies the bytes without a null terminator
@(s.toOpenArrayByte(0, s.high))

func toBytes*(s: string): seq[byte] =
## Convert a string to the corresponding byte sequence - since strings in
## nim essentially are byte sequences without any particular encoding, this
## simply copies the bytes without a null terminator
when nimvm:
var r = newSeq[byte](s.len)
for i, c in s:
r[i] = cast[byte](c)
r
else:
@(s.toOpenArrayByte(0, s.high))
@(s.toOpenArrayByte(0, s.high))

func fromBytes*(T: type string, v: openArray[byte]): string =
if v.len > 0:
Expand Down
38 changes: 23 additions & 15 deletions tests/test_byteutils.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,21 +16,21 @@ proc compilationTest {.exportc: "compilationTest".} =
writeFile("test", bytes)

suite "Byte utils":
let simpleBArray = [0x12.byte, 0x34, 0x56, 0x78]
const simpleBArray = [0x12.byte, 0x34, 0x56, 0x78]

test "hexToByteArray: Inplace partial string":
dualTest "hexToByteArray: Inplace partial string":
let s = "0x1234567890"
var a: array[5, byte]
hexToByteArray(s, a, 1, 3)
check a == [0.byte, 0x34, 0x56, 0x78, 0]

test "hexToByteArray: Inplace full string":
dualTest "hexToByteArray: Inplace full string":
let s = "0xffffffff"
var a: array[4, byte]
hexToByteArray(s, a)
check a == [255.byte, 255, 255, 255]

test "hexToByteArrayStrict":
dualTest "hexToByteArrayStrict":
let
short0 = ""
short1 = "0x"
Expand All @@ -56,7 +56,7 @@ suite "Byte utils":
reject long1
reject long2

test "hexToByteArray: Return array":
dualTest "hexToByteArray: Return array":
let
s = "0x12345678"
a = hexToByteArray[4](s)
Expand All @@ -65,7 +65,7 @@ suite "Byte utils":
expect(ValueError): discard hexToByteArray[1]("")
expect(ValueError): discard hexToByteArray[1]("1")

test "hexToByteArray: missing bytes":
dualTest "hexToByteArray: missing bytes":
var buffer: array[1, byte]
expect(ValueError):
hexToByteArray("0x", buffer)
Expand All @@ -74,25 +74,25 @@ suite "Byte utils":
expect(ValueError):
hexToByteArray("0", buffer)

test "valid hex with empty array":
dualTest "valid hex with empty array":
var buffer: seq[byte]
hexToByteArray("0x123", openArray[byte](buffer))
check(buffer == seq[byte](@[]))

test "valid hex with empty array of size":
dualTest "valid hex with empty array of size":
var buffer: seq[byte] = newSeq[byte](4)
hexToByteArray("00000123", openArray[byte](buffer))
check(buffer == @[0.byte, 0.byte, 1.byte, 35.byte])
check buffer.toHex == "00000123"

test "empty output array is ok":
dualTest "empty output array is ok":
var output: array[0, byte]

hexToByteArray("", output)
hexToByteArray("0x", output)
hexToByteArray("0x32", output)

test "array.fromHex":
dualTest "array.fromHex":
let
s = "0x12345678"
a2 = array[2, byte].fromHex(s)
Expand All @@ -104,7 +104,7 @@ suite "Byte utils":

expect(ValueError): echo array[5, byte].fromHex(s)

test "toHex":
dualTest "toHex":
check simpleBArray.toHex == "12345678"
check hexToSeqByte("12345678") == simpleBArray
check hexToSeqByte("00") == [byte 0]
Expand All @@ -118,7 +118,7 @@ suite "Byte utils":
check simpleBArray & simpleBArray ==
[0x12.byte, 0x34, 0x56, 0x78, 0x12, 0x34, 0x56, 0x78]

test "hexToPaddedByteArray":
dualTest "hexToPaddedByteArray":
block:
let a = hexToPaddedByteArray[4]("0x123")
check a.toHex == "00000123"
Expand All @@ -138,7 +138,7 @@ suite "Byte utils":
expect ValueError:
discard hexToPaddedByteArray[2]("0x12345")

test "lessThan":
dualTest "lessThan":
let
a = [0'u8, 1, 2]
b = [2'u8, 1, 0]
Expand All @@ -160,17 +160,25 @@ suite "Byte utils":
c < d
not (d < c)

test "strings":
proc copyView(v: openArray[char]): seq[byte] =
v.toBytes()

dualTest "strings":
check:
"a".toBytes() == @[byte(ord('a'))]
copyView("a") == @[byte(ord('a'))]

string.fromBytes([byte(ord('a'))]) == "a"
cast[ptr UncheckedArray[byte]](cstring(string.fromBytes([byte(ord('a'))])))[1] == byte(0)

"".toBytes().len() == 0
string.fromBytes([]) == ""
@[byte(ord('a'))] == static("a".toBytes())
"a" == static(string.fromBytes([byte(ord('a'))]))

test "strings cast":
check:
cast[ptr UncheckedArray[byte]](cstring(string.fromBytes([byte(ord('a'))])))[1] == byte(0)

test "slices":
var a: array[4, byte]
a[0..<2] = [2'u8, 3]
Expand Down