lib9p

doc.go (1607B)

---

 // Package lib9p is a 9P2000 library to implement 9P servers.
 // For detailed information on 9P protocol, consult the protocol's documentation.
 //
 // To use this package, implement the [FS] interface, and
 // create a [Server] struct by calling [NewServer] with the [FS], and
 // then call [*Server.Serve].
 // The server listens to r specified by the argument of [NewServer] and
 // writes responses to w.
 // It does not assume network connection, and can be used with any
 // [io.Reader]/[io.Writer].
 // If the server is to serve via a tcp connection, write something like the
 // following code:
 //
 //	l, err := net.Listen("tcp", "localhost:5640")
 //	if err != nil {
 //		log.Fatal(err)
 //	}
 //	for {
 //		conn, err := l.Accept()
 //		if err != nil {
 //			log.Print(err)
 //		}
 //		s := lib9p.NewServer(fsys) // fsys is user defined *FS.
 //		go s.Serve(context.Background(), conn, conn)
 //	}
 //
 // OpenFile method of [FS] interface is similar to that of [os.OpenFile],
 // but it takes as argument OpenMode instead of integer flag.
 // And it does not create file even if the specified file does not exists.
 // The returned value is [File], not [fs.File].
 //
 // A [File] is the representation of a file of the exported file system.
 // It is almost identical to [fs.File], but the Stat method returns the
 // [*FileInfo] struct instead of [fs.FileInfo] interface.
 // The difference of [*FileInfo] and [fs.FileInfo] is that the Sys method
 // of [*FileInfo] returns the underlying [*Stat] struct as a value of any,
 // while I can't asume anything on Stat of [fs.FileInfo].
 // This ensures the type safety.
 package lib9p