Ecoji

A Rust implementation of the Ecoji encoding standard.

Provides an API for encoding and decoding data as a base-1024 sequence of emojis.

Usage

This library is published to Maven Central, so you can add it to your dependencies configuration in your build tool of choice.

Maven:

<dependency>
    <groupId>io.github.netvl.ecoji</groupId>
    <artifactId>ecoji</artifactId>
    <version>${versions.ecoji}</version>
</dependency>

Gradle:

implementation group: 'io.github.netvl.ecoji', name: 'ecoji', version: versions.ecoji

SBT:

libraryDependencies += "io.github.netvl.ecoji" % "ecoji" % versions.ecoji

Use the latest available version, which you can find in Maven Central or on the badge at the top of this file.

Afterwards, import the io.github.netvl.ecoji.Ecoji class and use its getEncoder() and getDecoder() static methods to obtain instances of the Ecoji.Encoder and Ecoji.Decoder classes. These can then be used to describe encoding/decoding sources and targets. For example:

import io.github.netvl.ecoji.Ecoji;

String encoded = Ecoji.getEncoder().readFrom("hello world").writeToString();
String decoded = Ecoji.getDecoder().readFrom(encoded).writeToString();
assert decoded.equals("hello world");

See javadocs for more information.

License

This program is licensed under Apache License, Version 2.0, (LICENSE or http://www.apache.org/licenses/LICENSE-2.0).