@spec decode(puid :: String.t()) :: bitstring() | Puid.Error.t()

Decode puid into representative bits.

puid must a representative puid from this module.

NOTE: decode/1 is not supported for non-ascii character sets

@spec encode(bits :: bitstring()) :: String.t() | Puid.Error.t()

Encode bits into a puid.

bits must contain enough bits to create a puid. The rest are ignored.

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

Generate a puid

@spec info() :: %Puid.Info{
  char_set: term(),
  characters: term(),
  entropy_bits: term(),
  entropy_bits_per_char: term(),
  ere: term(),
  length: term(),
  rand_bytes: term()
}

Puid.Info module info

@spec risk(total :: float()) :: integer()

Approximate risk in genertating total puids

@spec total(risk :: float()) :: integer()

Approximate total possible puids at a specified risk