BrushFamilySerialization

Summary

Public functions
BrushFamily
decode(input: InputStream, maxVersion: Version)

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing or validation was not successful.
android
Unit
encode(brushFamily: BrushFamily, output: OutputStream)

Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream.
android

Public functions

decode

android
Added in 1.1.0-alpha02
fun decode(input: InputStream, maxVersion: Version = Version.MAX_SUPPORTED): BrushFamily

Read a serialized BrushFamily from the given InputStream and parse it into a BrushFamily, throwing an exception if parsing or validation was not successful. Kotlin callers should use BrushFamily.Companion.decode instead.

Parameters
input: InputStream

InputStream providing gzip-compressed ink.proto.BrushFamily binary proto messages, the same as written to OutputStream by encode.
maxVersion: Version = Version.MAX_SUPPORTED

The maximum Version supported by the deserializer. Proto objects with a min_version of greater than maxVersion will be rejected.
Returns
BrushFamily

The BrushFamily parsed from the InputStream.
Throws
java.io.IOException

if gzip-format bytes cannot be read from input.
IllegalArgumentException

input does not provide a valid ink.proto.BrushFamily proto message, or the corresponding BrushFamily is invalid.

encode

android
Added in 1.0.0
fun encode(brushFamily: BrushFamily, output: OutputStream): Unit

Write a gzip-compressed serialized ink.proto.BrushFamily proto message representing the BrushFamily to the given OutputStream. If hasFallbacks is true, then the stored proto message including fallbacks for this BrushFamily will be used instead of recomputing the proto from the BrushFamily object.