Crate hiirc

Expand description

hiirc is a library built on top of loirc. The goal is to offer a friendly, event-based API.

To use the library, implement the Listener trait and give an instance of your implementation to the dispatch function, accompanied with an instance of the Settings struct configured to your needs. You can also use the Settings struct as a builder, calling the dispatch method once it is configured to your needs.

Modules§

ext: Utilities that are not part of the official IRC protocol standard.

Structs§

Channel: Channel
ChannelUser: User inside a channel.
Irc: Contains the connection to the server and the data about channels and users.
Message: Represents a message received from the server.
MonitorSettings: These settings tell the monitor how to behave.
PrefixUser: User prefix representation.
Settings: Settings for the dispatcher.

Enums§

ChannelUserStatus: Status of a user inside a channel.
Code: Representation of IRC commands, replies and errors.
ConnectionStatus: Status of the connection.
Error: Errors that can occur.
Event: This is the comprehensive set of events that can occur.
LoircError: Errors produced by the Writer.
ParseError: Error generated by the parser.
Prefix: Prefix of the message.
ReconnectionSettings: These settings tell the reconnection process how to behave.

Traits§

IrcWrite: Ability to send commands to the irc server.
Listener: Implement this trait to handle events.

Functions§