[−][src]Crate twitchchat

This crate provides a way to interface with Twitch's chat.

Along with the messages as Rust types, it provides methods for sending messages.

Demonstration

See examples/demo.rs for a demo of the api

client	Event handling.
color	Color types associated with Twitch.
decode	Decode messages from a `&str`
encode	Encode messages to a writer
events	Available event filters.
messages	Messages sent by the server
sync	Synchronous methods
twitch	Common Twitch types

Badge	Badges attached to a message
Channel	Simple channel wrapper.
Client	Client allows for reading and writing.
Emotes	Emotes are little pictograms used in-line in Twitch messages
Tags	Tags are IRCv3 message tags. Twitch uses them extensively.
UserConfig	User configuration for 'registering' with Twitch
UserConfigBuilder	Builder for making a UserConfig

BadgeKind	The kind of the badges that are associated with messages.
Capability	Capability used to enable extra functionality with the protocol
ChannelError	An error produced by invalid channel names
Error	An error returned by the Client
Secure	Connection type
UserConfigError	User config error returned by the UserConfigBuilder

ANONYMOUS_LOGIN	An anonymous login.
TWITCH_IRC_ADDRESS	The Twitch IRC address for non-TLS connections
TWITCH_IRC_ADDRESS_TLS	The Twitch IRC address for TLS connections
TWITCH_WS_ADDRESS	The Twitch WebSocket address for non-TLS connections
TWITCH_WS_ADDRESS_TLS	The Twitch WebSocket address for TLS connections

Conversion	A trait for converting crate types between `Owned` and `Borrowed` representations
Encodable	Encode this message to the buffer
IntoChannel	A trait to convert types into `Channel`
Parse	A trait for parsing messages
StringMarker	Marker trait for the 'storage' abstraction of the types

connect	Opens an async TCP connection using the provided `UserConfig` and `Secure` setting
connect_easy	Opens an async TCP connection using the provided `name`, `token` and `Secure` setting
decode	Tries to decode potentially many messages from this input string
decode_one	Tries to decode one message, returning the amount of remaining data in the input
encode	Encode the provided message to the tokio::io::AsyncWrite
register	Write the provided `UserConfig` to the async writer