Encoder and decoder for the Base24 encoding
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Nicolas Goy 90f008a09f Update gradle 3 weeks ago
.github/workflows Create gradle.yml 2 years ago
gradle/wrapper Update gradle 3 weeks ago
src Add a few hard coded tests 2 years ago
.editorconfig Base implementation 2 years ago
.gitattributes Base implementation 2 years ago
.gitignore Ignore envrc 2 years ago
LICENSE-APACHE Add license 2 years ago
LICENSE-MIT Add license 2 years ago
MAKE.md Add makefile 2 years ago
Makefile Remove bintray 3 weeks ago
README.md Remove bintray 3 weeks ago
build.gradle.kts Remove bintray 3 weeks ago
gradlew Base implementation 2 years ago
gradlew.bat Base implementation 2 years ago
settings.gradle.kts Base implementation 2 years ago

README.md

GitHub Workflow Status Version License

Base24 encoder/decoder for Java

This library is an encoder/decoder for the Base24 encoding written in Kotlin.

Usage

When using gradle (Kotlin DSL):

Add the repository:


repositories {
    maven {
        setUrl("https://maven.goyman.com")
    }
}

Add the following dependencies:

dependencies {
    // ...
    implementation("ch.kuon.commons:base24:0.1.1")
    // ...
}

Then the API is very simple:


object ch.kuon.commons.Base24

/**
 * Encode bytes to a string using base24
 * @param data A byte array. Length must be multiple of 4.
 * @return The encoded string
 */
fun encode24(data: ByteArray): String

/**
 * Decode a string to byte array using base24
 * @param data A string encoded un base24. Length must be multiple of 7
 * @return The decoded bytes
 */
fun decode24(data: String): ByteArray

Example

import ch.kuon.commons.Base24.encode24
import ch.kuon.commons.Base24.decode24

val bytes = byteArrayOf(1, 2, 3, 4)
val myString = encode24(bytes)

myString == "ZCCYBZB" // true

val decodedBytes = decode24("2Z42F6A")

decodedBytes contentEquals byteArrayOf(0x22, 0x55, 0x33, 0x11) // true

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.