MM-11292: clean up plugins GoDoc (#9109)
* clean up plugins GoDoc: - eliminate plugin.NewBlankContext() as unnecessary - export ValidIdRegex as a string vs. the less readable var - add/update various documentation strings - hide everything by default, except where used by client plugins or the mattermost-server. The exception to this rule are the `*(Args|Returns)` structs which must be public for go-plugin, but are now prefixed with `Z_` with a warning not to use. - include a top-level example to get plugin authors started This is not a breaking change for existing plugins compiled against plugins-v2. * remove commented out ServeHTTPResponseWriter * update examples to match developer docs * add missing plugin/doc.go license header
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
5ddb08dcb4
Коммит
17f211c393
@@ -22,15 +22,11 @@ func (rwc *rwc) Close() (err error) {
|
||||
return
|
||||
}
|
||||
|
||||
func NewReadWriteCloser(r io.ReadCloser, w io.WriteCloser) io.ReadWriteCloser {
|
||||
return &rwc{r, w}
|
||||
}
|
||||
|
||||
type RemoteIOReader struct {
|
||||
type remoteIOReader struct {
|
||||
conn io.ReadWriteCloser
|
||||
}
|
||||
|
||||
func (r *RemoteIOReader) Read(b []byte) (int, error) {
|
||||
func (r *remoteIOReader) Read(b []byte) (int, error) {
|
||||
var buf [10]byte
|
||||
n := binary.PutVarint(buf[:], int64(len(b)))
|
||||
if _, err := r.conn.Write(buf[:n]); err != nil {
|
||||
@@ -39,15 +35,15 @@ func (r *RemoteIOReader) Read(b []byte) (int, error) {
|
||||
return r.conn.Read(b)
|
||||
}
|
||||
|
||||
func (r *RemoteIOReader) Close() error {
|
||||
func (r *remoteIOReader) Close() error {
|
||||
return r.conn.Close()
|
||||
}
|
||||
|
||||
func ConnectIOReader(conn io.ReadWriteCloser) io.ReadCloser {
|
||||
return &RemoteIOReader{conn}
|
||||
func connectIOReader(conn io.ReadWriteCloser) io.ReadCloser {
|
||||
return &remoteIOReader{conn}
|
||||
}
|
||||
|
||||
func ServeIOReader(r io.Reader, conn io.ReadWriteCloser) {
|
||||
func serveIOReader(r io.Reader, conn io.ReadWriteCloser) {
|
||||
cr := bufio.NewReader(conn)
|
||||
defer conn.Close()
|
||||
buf := make([]byte, 32*1024)
|
||||
|
||||
Ссылка в новой задаче
Block a user