Changeset 249 in code for trunk

Timestamp:

Apr 7, 2020, 8:30:54 PM (5 years ago)

Author:

contact

Message:

Document downstreamConn.{,un}marshalEntity

File:

• trunk/downstream.go (modified) (2 diffs)

trunk/downstream.go

@@ -122 +122 @@
 }
 
+// marshalEntity converts an upstream entity name (ie. channel or nick) into a
+// downstream entity name.
+//
+// This involves adding a "/<network>" suffix if the entity isn't the current
+// user.
 func (dc *downstreamConn) marshalEntity(uc *upstreamConn, entity string) string {
         if uc.isChannel(entity) {
@@ -136 +141 @@
 }
 
+// unmarshalEntity converts a downstream entity name (ie. channel or nick) into
+// an upstream entity name.
+//
+// This involves removing the "/<network>" suffix.
 func (dc *downstreamConn) unmarshalEntity(name string) (*upstreamConn, string, error) {
         if uc := dc.upstream(); uc != nil {