hfile.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include "htslib/hfile.h"
#include "hfile_internal.h"
#include <sys/socket.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>

Classes
struct	hFILE_fd
struct	hFILE_mem

Functions
hFILE *	hfile_init (size_t struct_size, const char *mode, size_t capacity)
void	hfile_destroy (hFILE *fp)
int	hgetc2 (hFILE *fp)
ssize_t	hpeek (hFILE *fp, void *buffer, size_t nbytes)
ssize_t	hread2 (hFILE *fp, void *destv, size_t nbytes, size_t nread)
int	hflush (hFILE *fp)
int	hputc2 (int c, hFILE *fp)
ssize_t	hwrite2 (hFILE *fp, const void *srcv, size_t totalbytes, size_t ncopied)
int	hputs2 (const char *text, size_t totalbytes, size_t ncopied, hFILE *fp)
off_t	hseek (hFILE *fp, off_t offset, int whence)
int	hclose (hFILE *fp)
void	hclose_abruptly (hFILE *fp)
hFILE *	hdopen (int fd, const char *mode)
int	hfile_oflags (const char *mode)
hFILE *	hopen (const char *fname, const char *mode)

Function Documentation

int hclose

(

hFILE *

fp

)

Flush (for output streams) and close the stream

Returns

0 if successful, or EOF (with errno set) if an error occurred.

void hclose_abruptly

(

hFILE *

fp

)

Close the stream, without flushing or propagating errors For use while cleaning up after an error only. Preserves errno.

hFILE* hdopen	(	int	fd,
		const char *	mode
	)

Associate a stream with an existing open file descriptor

Returns

An hFILE pointer, or NULL (with errno set) if an error occurred. For socket descriptors (on Windows), mode should contain 's'.

void hfile_destroy

(

hFILE *

fp

)

hFILE* hfile_init	(	size_t	struct_size,
		const char *	mode,
		size_t	capacity
	)

int hfile_oflags

(

const char *

mode

)

int hflush

(

hFILE *

fp

)

For writing streams, flush buffered output to the underlying stream

Returns

0 if successful, or EOF if an error occurred.

int hgetc2

(

hFILE *

fp

)

hFILE* hopen	(	const char *	filename,
		const char *	mode
	)

Open the named file or URL as a stream

Returns

An hFILE pointer, or NULL (with errno set) if an error occurred.

ssize_t hpeek	(	hFILE *	fp,
		void *	buffer,
		size_t	nbytes
	)

Peek at characters to be read without removing them from buffers

Parameters

fp	The file stream
buffer	The buffer to which the peeked bytes will be written
nbytes	The number of bytes to peek at; limited by the size of the internal buffer, which could be as small as 4K.

Returns

The number of bytes peeked, which may be less than nbytes if EOF is encountered; or negative, if there was an I/O error. The characters peeked at remain in the stream's internal buffer, and will be returned by later hread() etc calls.

int hputc2	(	int	c,
		hFILE *	fp
	)

int hputs2	(	const char *	text,
		size_t	totalbytes,
		size_t	ncopied,
		hFILE *	fp
	)

ssize_t hread2	(	hFILE *	fp,
		void *	destv,
		size_t	nbytes,
		size_t	nread
	)

off_t hseek	(	hFILE *	fp,
		off_t	offset,
		int	whence
	)

Reposition the read/write stream offset

Returns

The resulting offset within the stream (as per lseek(2)), or negative if an error occurred.

ssize_t hwrite2	(	hFILE *	fp,
		const void *	srcv,
		size_t	totalbytes,
		size_t	ncopied
	)