net/http: mention io.Seeker requirement in FS documentation #48781
Conversation
|
This PR (HEAD: 319a4d9) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/go/+/353874 to see it. Tip: You can toggle comments from me using the |
|
Message from Go Bot: Patch Set 1: Congratulations on opening your first change. Thank you for your contribution! Next steps: Most changes in the Go project go through a few rounds of revision. This can be During May-July and Nov-Jan the Go project is in a code freeze, during which Please don’t reply on this GitHub thread. Visit golang.org/cl/353874. |
|
This PR (HEAD: 655be81) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/go/+/353874 to see it. Tip: You can toggle comments from me using the |
|
Message from Damien Neil: Patch Set 3: Trust+1 (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/353874. |
Both FileServer and NewFileTransport can try to seek a file, specifically when MIME type sniffing is performed. This can be somewhat surprising to an implementer of an fs.FS, as their filesystem will appear to work until a user tries to access a file with an unrecognized extension (which requires type sniffing and therefore seeking). With FileServer, this results in a "seeker can't seek" message, which is not very clear for the developer. The issue arises because fs.FS does not require Seek, while http.FileSystem does. Therefore, this change adds a line to the documentation of net/http's adapter function mentioning the requirement.
|
This PR (HEAD: 56d2d41) has been imported to Gerrit for code review. Please visit https://go-review.googlesource.com/c/go/+/353874 to see it. Tip: You can toggle comments from me using the |
Both FileServer and NewFileTransport can try to seek a file, specifically
when MIME type sniffing is performed. This can be somewhat surprising to an
implementer of an fs.FS, as their filesystem will appear to work until a
user tries to access a file with an unrecognized extension (which requires
type sniffing and therefore seeking). With FileServer, this results in a
"seeker can't seek" message, which is not very clear for the developer.
The issue arises because fs.FS does not require Seek, while http.FileSystem
does. Therefore, this change adds a line to the documentation of net/http's
adapter function mentioning the requirement.
The text was updated successfully, but these errors were encountered: