home | help
bl_fastx_read(3)	    Library Functions Manual		bl_fastx_read(3)

NAME
     bl_fastx_read() - Read a FASTX record

LIBRARY
     #include <biolibc/fastx.h>
     -lbiolibc -lxtend

SYNOPSIS
     int     bl_fastx_read(bl_fastx_t *record, FILE *fastx_stream)

ARGUMENTS
     fastx_stream    FILE stream from which FASTA data are read
     record	     Pointer to a bl_fastx_t structure to receive data

DESCRIPTION
     Read a FASTA or FASTQ record from a FILE stream by calling bl_read_fasta(3)
     or bl_read_fastq(3).  The bl_fastx_t structure must first be initialized by
     assigning	  it	BL_FASTX_INIT	and   calling	bl_fastx_init(3).    See
     bl_fasta_read(3) and bl_fastq_read(3) for further details.

RETURN VALUES
     BL_READ_OK   upon	 successful   read   of   description	 and	sequence
     BL_READ_BAD_DATA  if something is amiss with input format BL_READ_EOF if no
     more data are available

EXAMPLES
     bl_fastx_t  rec = BL_FASTX_INIT;

     bl_fastx_init(stdin, &rec);
     while ( bl_fastx_read(stdin, &rec) != BL_READ_EOF )
	 bl_fastx_write(stdout, &rec, BL_FASTX_LINE_UNLIMITED);
     bl_fastx_free(&rec);

SEE ALSO
     bl_fastx_write(3), bl_fastq_read(3), bl_fastq_write(3), bl_fastx_free(3)

								bl_fastx_read(3)

home | help