base32/io.matthewnelson.encoding.base32/Base32CrockfordConfigBuilder

Base32CrockfordConfigBuilder

class Base32CrockfordConfigBuilder(source)

Builder for creating a Base32.Crockford.Config.

See also

Constructors

Link copied to clipboard
constructor()
constructor(config: Base32.Crockford.Config?)

Properties

Link copied to clipboard
@get:JvmName(name = "checkSymbol")
var checkSymbol: Char?
Link copied to clipboard
@JvmField
var encodeToLowercase: Boolean

If true, will output lowercase characters when encoding (against Crockford spec).

Link copied to clipboard
@JvmField
var finalizeWhenFlushed: Boolean

If true, whenever Encoder.Feed.flush is invoked:

Link copied to clipboard
@JvmField
var hyphenInterval: Byte

For every hyphenInterval of encoded output, a hyphen ("-") will be inserted.

Link copied to clipboard
@JvmField
var isLenient: Boolean

If true, spaces and new lines ('\n', '\r', ' ', '\t') will be skipped over when decoding (against Crockford spec).

Functions

Link copied to clipboard
fun build(): Base32.Crockford.Config

Builds a Base32.Crockford.Config for the provided settings.

Link copied to clipboard
fun checkSymbol(symbol: Char?): Base32CrockfordConfigBuilder

Specify an optional check symbol to be appended to the encoded output, and verified when decoding (fail quickly).

Link copied to clipboard
fun strict(): Base32CrockfordConfigBuilder

A shortcut for configuring things to be in strict adherence with the Crockford spec.