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

Add hts_flush() API function #1326

Merged
merged 1 commit into from
Sep 2, 2021
Merged

Add hts_flush() API function #1326

merged 1 commit into from
Sep 2, 2021

Conversation

jmarshall
Copy link
Member

@jmarshall jmarshall commented Aug 31, 2021

The various underlying file types provide flush routines, but htsFile to date does not.

Also add sam_flush() and bcf_flush() wrappers. There was a temptation to make these static inline functions, but instead I followed the existing pattern for sam_* and bcf_* wrappers of hts_* functions via #define.

This API function is needed by an upcoming samtools PR that wants to flush a samFile.

@valeriuo
Copy link
Contributor

valeriuo commented Sep 1, 2021

A NEWS entry about these interfaces would be appreciated.

Implemented by calling through to the various underlying flush routines.
Also add sam_flush() and bcf_flush() wrappers.
@jmarshall
Copy link
Member Author

NEWS entry added, along with adding @since 1.14 to the hts_flush() doco comment — I assume the version this appears in will be called 1.14.

@valeriuo valeriuo merged commit 238fe32 into samtools:develop Sep 2, 2021
@jmarshall jmarshall deleted the flush branch September 2, 2021 09:50
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

Successfully merging this pull request may close these issues.

2 participants