Bunch v1.6.0

View Source Bunch.ShortRef (Bunch v1.6.0)

A wrapper over Erlang/Elixir references that makes them more readable and visually distinguishable.

erlang-references

 Erlang references

When printed, Erlang references are quite long: #Reference<0.133031758.722993155.68472>. Moreover, since they're based on an incremented counter, it's hard to distinguish between a two created within the same period of time, like #Reference<0.133031758.722993155.68512> and #Reference<0.133031758.722993155.68519>.

bunch-shortref

 Bunch.ShortRef

Bunch.ShortRef.t/0 stores a usual reference along with first 4 bytes of its SHA1 hash and when inspected prints only 8 hex digits prepended with #. Thanks to use of the hash function, similar references have totally different string representations - the case from the previous example would be #60e0fd2d and #d4208051.

when-to-use

 When to use

Bunch.ShortRef should be used when a reference is to be printed or logged. It should NOT be used when creating lots of references as it adds a significant performance overhead.

Link to this section Summary

Types

t()

Functions

new(ref \\ make_ref())

Creates a short reference.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Bunch.ShortRef{hash: String.t(), ref: reference()}

Link to this section Functions

Link to this function

new(ref \\ make_ref())

View Source 
@spec new(reference()) :: t()

Creates a short reference.

iex> IEx.Helpers.ref(0, 1, 2, 3) |> Bunch.ShortRef.new() |> inspect()
"#82c033ef"
iex> <<"#", hash::binary-size(8)>> = Bunch.ShortRef.new() |> inspect()
iex> Base.decode16(hash, case: :lower) |> elem(0)
:ok