Skip to content

Add missing docs for ByteString factory #396

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

Merged
merged 1 commit into from
Oct 21, 2024
Merged

Add missing docs for ByteString factory #396

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
5 changes: 5 additions & 0 deletions bytestring/common/src/ByteString.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ public fun ByteString(vararg bytes: UByte): ByteString = if (bytes.isEmpty()) {
ByteString.wrap(bytes.asByteArray())
}

/**
* Returns an empty [ByteString].
*
* @sample kotlinx.io.bytestring.samples.ByteStringSamples.constructEmpty
*/
@JsName("EmptyByteString")
public fun ByteString(): ByteString = ByteString.EMPTY

Expand Down
7 changes: 7 additions & 0 deletions bytestring/common/test/samples/samples.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,4 +247,11 @@ class ByteStringSamples {

assertEquals(ByteString(3, 4, 5, 6), byteString)
}

@Test
fun constructEmpty() {
val byteString = ByteString()
assertTrue(byteString.isEmpty())
assertContentEquals(ByteArray(0), byteString.toByteArray())
}
}