Skip to content

Latest commit

 

History

History
93 lines (69 loc) · 3.22 KB

CharsetsReadme.md

File metadata and controls

93 lines (69 loc) · 3.22 KB
Raw

Kotlin Multiplatform Charset

A Kotlin Multiplatform library providing support for standard and extended character sets, enabling seamless encoding and decoding across platforms.

Modules

  1. charset com.fleeksoft.charset:charset:<version>:

  2. charset-ext com.fleeksoft.charset:charset-ext:<version>:

    • Extends the functionality by providing support for additional character sets.
    • Useful for applications that require a broader range of character encoding.
    • Check Extended Charsets List

Features

  • Cross-platform compatibility for mobile, desktop, and web applications.
  • Simple API for encoding and decoding strings.
  • Lightweight and easy to integrate into your Kotlin projects.

Installation

Add the following dependencies to your project:

Gradle

Latest Version

Maven Central

commonMain.dependencies {
    implementation("com.fleeksoft.charset:charset:<version>") //only standard charsets
   //or
    implementation("com.fleeksoft.charset:charset-ext:<version>") // standard + extended charsets
}

Usage Example

Here is a simple example of how to use the library to encode and decode strings:

Initializing

You can initialize a Charset in two ways:

// Using INSTANCE variable for Standard Charsets
val charset: Charset = UTF_8.INSTANCE // This INSTANCE variable is available only for Standard Charsets

// Or, by using forName method
val charset: Charset = Charsets.forName("UTF-8") // charset name can be any case it will be normalized in lower case and remove `-` and `_`

Encoding & Decoding with Extension Functions

// Encoding
// You can use extension functions to encode a string to a ByteArray:
val inputString = "Hello, World!"
val encodedBytes: ByteArray = inputString.toByteArray(charset) // ext fun from com.fleeksoft.charset.toByteArray
println("Encoded Bytes: ${encodedBytes.joinToString()}")

// Decoding
// You can decode the ByteArray back to a String using an extension function:
val decodedString: String = encodedBytes.decodeToString(charset) // ext from com.fleeksoft.charset.decodeToString
println("Decoded String: $decodedString")

Encoding & Decoding with Default Instance

//encode
val byteArray: ByteBuffer = Charsets.forName("UTF-8").encode("Hello, World!")

//decode
val decodedCharBuffer: CharBuffer = Charsets.forName("UTF-8").decode(byteArray)

Encoding & Decoding by Creating New Encoder and Decoder Instance

//encoding
val encoder = Charsets.forName("UTF-8").newEncoder()
val encodedByteBuffer = encoder.encode(CharBufferFactory.wrap(inputString))

//decoding
val decoder = Charsets.forName("UTF-8").newDecoder()
val decodedCharBuffer1: CharBuffer = decoder.decode(ByteBufferFactory.wrap(encodedBytes))


//decoding with CharArray
val charArray = CharArray(5)
val charBuffer: CharBuffer = CharBufferFactory.wrap(charArray)
decoder.decode(ByteBufferFactory.wrap(encodedBytes), charBuffer, true)