rotn

v0.2.0

rotn v0.2.0 Rotn View Source

Rotn takes a compatible binary and an integer value and rotates the corresponding characters of the binary by the integer value around a circle of ASCII values from 32 - 126 inclusive.

Link to this section Summary

Functions

decode(text, delta)

Returns an {:ok, "decoded string"} tuple

decode!(text, delta)

Returns an decoded string, raising an ArgumentError if the provided text cannot be decoded or the shift value is invalid

encode(text, delta)

Returns an {:ok, "encoded string"} tuple

encode!(text, delta)

Returns an encoded string, raising an ArgumentError if the provided text cannot be encoded or the shift value is invalid

Link to this section Functions

Link to this function

decode(text, delta) View Source 
decode(binary(), integer()) :: {:ok | :error, binary()}

Returns an {:ok, "decoded string"} tuple.

Examples 

iex> Rotn.decode("V-z$\"#-{|#-srn!", 13)
{:ok, "I must not fear"}

iex> Rotn.decode(68.9, 13)
{:error, "Cannot decode non-binary"}

iex> Rotn.decode("/# 92z/ -9{ '*)\".9/*9/# 9/-${ ", 2.5)
{:error, "Incompatible shift value"}

iex> Rotn.decode("Zyu(4})4*|y4#}$x!}\"\"y(", -20)
{:ok, "Fear is the mindkiller"}
Link to this function

decode!(text, delta) View Source 
decode!(binary(), integer()) :: binary() | no_return()

Returns an decoded string, raising an ArgumentError if the provided text cannot be decoded or the shift value is invalid.

Examples 

iex> Rotn.decode!("V-z$\"#-{|#-srn!", 13)
"I must not fear"

iex> Rotn.decode!(68.9, 13)
** (ArgumentError) Cannot decode non-binary

iex> Rotn.decode!("/# 92z/ -9{ '*)\".9/*9/# 9/-${ ", 2.5)
** (ArgumentError) Incompatible shift value
Link to this function

encode(text, delta) View Source 
encode(binary(), integer()) :: {:ok | :error, binary()}

Returns an {:ok, "encoded string"} tuple.

Examples 

iex> Rotn.encode("I must not fear", 13)
{:ok, "V-z$\"#-{|#-srn!"}

iex> Rotn.encode(68.9, 13)
{:error, "Cannot encode non-binary"}

iex> Rotn.encode("the water belongs to the tribe", 2.5)
{:error, "Incompatible shift value"}

iex> Rotn.encode("Fear is the mindkiller", -20)
{:ok, "Zyu(4})4*|y4#}$x!}\"\"y("}
Link to this function

encode!(text, delta) View Source 
encode!(binary(), integer()) :: binary() | no_return()

Returns an encoded string, raising an ArgumentError if the provided text cannot be encoded or the shift value is invalid.

Examples 

iex> Rotn.encode!("I must not fear", 13)
"V-z$\"#-{|#-srn!"

iex> Rotn.encode!(68.9, 13)
** (ArgumentError) Cannot encode non-binary

iex> Rotn.encode!("the water belongs to the tribe", 2.5)
** (ArgumentError) Incompatible shift value