summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/sorcix/irc/doc.go
diff options
context:
space:
mode:
authorWim <wim@42.be>2016-04-10 23:39:38 +0200
committerWim <wim@42.be>2016-04-10 23:39:38 +0200
commitde4c7804101a47a01d0c9b88ea34d2b153e2b6b9 (patch)
treefa379bc2e706951a913e0c7009d9906e42363655 /vendor/github.com/sorcix/irc/doc.go
parent6b18257185b1830bd2eff83fae30bdd2055f78b0 (diff)
downloadmatterbridge-msglm-de4c7804101a47a01d0c9b88ea34d2b153e2b6b9.tar.gz
matterbridge-msglm-de4c7804101a47a01d0c9b88ea34d2b153e2b6b9.tar.bz2
matterbridge-msglm-de4c7804101a47a01d0c9b88ea34d2b153e2b6b9.zip
Vendor libs
Diffstat (limited to 'vendor/github.com/sorcix/irc/doc.go')
-rw-r--r--vendor/github.com/sorcix/irc/doc.go36
1 files changed, 36 insertions, 0 deletions
diff --git a/vendor/github.com/sorcix/irc/doc.go b/vendor/github.com/sorcix/irc/doc.go
new file mode 100644
index 00000000..0effeb8a
--- /dev/null
+++ b/vendor/github.com/sorcix/irc/doc.go
@@ -0,0 +1,36 @@
+// Copyright 2014 Vic Demuzere
+//
+// Use of this source code is governed by the MIT license.
+
+// Package irc allows your application to speak the IRC protocol.
+//
+// The Message and Prefix structs provide translation to and from raw IRC messages:
+//
+// // Parse the IRC-encoded data and store the result in a new struct:
+// message := irc.ParseMessage(raw)
+//
+// // Translate back to a raw IRC message string:
+// raw = message.String()
+//
+// Decoder and Encoder can be used to decode and encode messages in a stream:
+//
+// // Create a decoder that reads from given io.Reader
+// dec := irc.NewDecoder(reader)
+//
+// // Decode the next IRC message
+// message, err := dec.Decode()
+//
+// // Create an encoder that writes to given io.Writer
+// enc := irc.NewEncoder(writer)
+//
+// // Send a message to the writer.
+// enc.Encode(message)
+//
+// The Conn type combines an Encoder and Decoder for a duplex connection.
+//
+// c, err := irc.Dial("irc.server.net:6667")
+//
+// // Methods from both Encoder and Decoder are available
+// message, err := c.Decode()
+//
+package irc