irc

v0.1.0

irc v0.1.0 Irc.Message.Command View Source

A simple type representing the finite set of valid command and reply codes

This type essentially functions as an Enumeration, so while it is technically just an atom, only a specific set of atoms are considered valid, and attempting to use invalid values will result in an InvalidIrcMessageError.

Link to this section Summary

Types

t()

Functions

decode(str)

Attempts to convert the given string into a Command

encode!(command)

Converts the Command into its string representation

Link to this section Types

Link to this section Functions

Link to this function decode(str) View Source 
decode(String.t) ::
  {:ok, Irc.Message.Command.t} |
  {:error, String.t}

Attempts to convert the given string into a Command

Link to this function encode!(command) View Source 
encode!(Irc.Message.Command.t) :: String.t

Converts the Command into its string representation

Note: passing an invalid C ommand will raise an error