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

Feature request: Writer::terminate_record #302

Open
vi opened this issue Feb 28, 2023 · 1 comment
Open

Feature request: Writer::terminate_record #302

vi opened this issue Feb 28, 2023 · 1 comment

Comments

@vi
Copy link

vi commented Feb 28, 2023

What version of the csv crate are you using?

1.2.0

Briefly describe the question, bug or feature request.

csv::Writer::write_field suggests to use write_record with empty iterator to terminate a record:

Note that if this API is used, write_record should be called with an empty iterator to write a record terminator.

However, using write_record this way requires a clumsy turbofish, as shown in the documentation:

wtr.write_record(None::<&[u8]>)?;

It is even more confusing if user tries to go the wtr.write_recrord::<?, ?>(...); route instead.

I suggest to add a dedicated method like terminate_record that is equivalent to write_record(None::<&[u8]>), then update documentation of write_field to use that method.

@BurntSushi
Copy link
Owner

I suppose, although the problem I have with this is that using write_field is already pretty niche, and I think I'm probably okay with having to write something a little annoying if what we get in return is one fewer method that could likely confused others and perhaps be called when it shouldn't be.

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

No branches or pull requests

2 participants