Add a WriteTo method that implements the io.WriterTo interface
#260
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit also adds a few comments and a deprecation note to the existing `Write(io.Writer) error` method which can now be replaced with the `WriteTo(io.Writer) (n int64, err error)` method.
VinGarcia
commented
Jun 19, 2023
| func (gp *GoPdf) formatXrefline(n int) string { | ||
| str := strconv.Itoa(n) | ||
| func (gp *GoPdf) formatXrefline(n int64) string { | ||
| str := strconv.FormatInt(n, 10) |
There was a problem hiding this comment.
The strconv.Itoa function accepts an int as argument, so it was necessary to use FormatInt instead since n is now an int64.
|
I don't have any questions. You explain everything very clear, even someone who is not strong English like me can understand easily and I have done merged pull request, thank you very much. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When reading the docs looking for a way of streaming the PDF as an HTTP response I actually skipped over the
Write(io.Reader) errorfunction because the name made me think it was an implementation of theio.Writerinterface.But it is not and its behavior actually is the behavior described by the
io.WriterTointerface.So I thought it was worth submitting this PR that basically renames the
Writefunction toWriteTochanging its signature slightly to match theio.WriterTointerface.The main goal here is to make the code easier to use for new comers by using a more canonical name for this function.
In order to keep retro-compatibility the old
Writermethod was not deleted but I've added a deprecation note.It was also necessary to change the countingWriter.offset variable from
inttoint64to comply with theio.WriterTointerface. A less intrusive implementation could be written where we could just convert frominttoint64when returning on theWriteTomethod, but this could potentially cause an overflow of that integer eventually.Feel free to ask me for any changes or even to change it yourself. I am all in favor of productivity and I know how little time we have to maintain these open-source projects.