Introduction#

MxPack is a modern Java library for reading and writing the MessagePack serialization format.

The Kotlin examples on this website use MxPack's Kotlin integration.

Example#

The following code writes a string and number to path, then reads them back:

var out = FileChannel.open(path, WRITE, CREATE);
try (var writer = MessageWriter.of(out)) { //Creates a MessageWriter that writes to out.
   The try block ensures that the writer is always closed and not used thereafter.

  writer.write("Hello, MxPack!");          //Encodes string "Hello, MxPack!" and writes it to out.

  writer.write(42);                        //Encodes number 42 and writes it to out.

}

var in = FileChannel.open(path);
try (var reader = MessageReader.of(in)) {  //Creates a MessageReader that reads from in.
   The try block ensures that the reader is always closed and not used thereafter.

  var string = reader.readString();        //Reads a string from in and decodes it to "Hello, MxPack!".

  var number = reader.readInt();           //Reads a number from in and decodes it to 42.

}

val out = FileChannel.open(path, WRITE, CREATE)
MessageWriter(out).use { writer ->     //Creates a MessageWriter that writes to out.
   The use {} block ensures that the writer is always closed and not used thereafter.

  writer.write("Hello, MxPack!")       //Encodes string "Hello, MxPack!" and writes it to out.

  writer.write(42)                     //Encodes number 42 and writes it to out.

}

val ch = FileChannel.open(path)
MessageReader(ch).use { reader ->      //Creates a MessageReader that reads from in.
   The use {} block ensures that the reader is always closed and not used thereafter.

  val string = reader.readString()     //Reads a string from in and decodes it to "Hello, MxPack!".

  val number = reader.readInt()        //Reads a number from in and decodes it to 42.

}

License#

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.