@spec binary_to_string(dsk_binary()) :: {:ok, dsk_string()}

Take a binary representation of the DSK and change it into the string representation

@spec new(binary()) :: t()

Make a new DSK

If less than 16 bytes are passed in, the rest are initialized to zero. Due to how DSKs are constructed, odd length binaries aren't allowed since they should never be possible.

@spec parse(dsk_string()) :: {:ok, t()} | {:error, :invalid_dsk}

Parse a textual representation of a DSK

@spec parse!(dsk_string()) :: t() | no_return()

Same as parse/1 but raises an ArgumentError if the DSK is invalid.

@spec parse_pin(String.t() | non_neg_integer()) :: {:ok, t()} | {:error, :invalid_dsk}

Parse a DSK PIN

PINs can also be parsed by parse/1. When working with PINs, though, it's nice to be more forgiving and accept PINs as integers or strings without leading zeros.

String examples:

iex> {:ok, dsk} = DSK.parse_pin("12345"); dsk
#DSK<12345-00000-00000-00000-00000-00000-00000-00000>


iex> {:ok, dsk} = DSK.parse_pin("123"); dsk
#DSK<00123-00000-00000-00000-00000-00000-00000-00000>

Integer examples:

iex> {:ok, dsk} = DSK.parse_pin(12345); dsk
#DSK<12345-00000-00000-00000-00000-00000-00000-00000>

iex> {:ok, dsk} = DSK.parse_pin(123); dsk
#DSK<00123-00000-00000-00000-00000-00000-00000-00000>

@spec string_to_binary(dsk_string()) :: {:ok, dsk_binary()} | {:error, :invalid_dsk}

Take a string representation of the DSK and change it into the binary representation

@spec to_pin_string(t()) :: String.t()

Return the first five digits of a DSK for use as a PIN

iex> {:ok, dsk} = DSK.parse("50285-18819-09924-30691-15973-33711-04005-03623")
iex> DSK.to_pin_string(dsk)
"50285"

iex> {:ok, dsk} = DSK.parse("00001-18819-09924-30691-15973-33711-04005-03623")
iex> DSK.to_pin_string(dsk)
"00001"

@spec to_string(
  t(),
  keyword()
) :: String.t()

Convert the DSK to a string

iex> {:ok, dsk} = DSK.parse("50285-18819-09924-30691-15973-33711-04005-03623")
iex> DSK.to_string(dsk)
"50285-18819-09924-30691-15973-33711-04005-03623"

iex> {:ok, dsk} = DSK.parse("50285-18819-09924-30691-15973-33711-04005-03623")
iex> DSK.to_string(dsk, delimiter: "")
"5028518819099243069115973337110400503623"

Options:

• :delimiter - character to join the 5 byte sections together (default "-")

@spec zeros() :: t()

Generate a DSK that is all zeros

This is useful for placeholder/default DSKs.