Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation of GzHeader::mtime #85

Closed
dtolnay opened this issue Apr 4, 2017 · 0 comments
Closed

Clarify documentation of GzHeader::mtime #85

dtolnay opened this issue Apr 4, 2017 · 0 comments

Comments

@dtolnay
Copy link
Member

dtolnay commented Apr 4, 2017

Returns the `mtime` field of this gzip stream's header, if present.

The mtime field is always required to be present. But it is 32 bits so because of the 2038 problem its use is discouraged. Most libraries set it to 0 and never look at it.

Document that the usage of mtime is discouraged and that 0 is the expected value for modern libraries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants