fastq

Documentation

Overview

Package fastq deals with Fastq reading and writing.

Index

• type Fastq
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Next() (*Fastq, error)

Types

type Fastq

type Fastq struct {
	Name     []byte // Entry name (without the '@')
	Sequence []byte // Sequence as received
	Quals    []byte // Qualities as received
}

Fastq represents a single Fastq entry.

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

A Reader reads text from an input and returns Fastq objects.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new Fastq reader.

func (*Reader) Next

func (r *Reader) Next() (*Fastq, error)

Next reads the next fastq entry from the reader. Returns a non-nil error if reading fails, or io.EOF if encountered end of file. When EOF is returned, no fastq is available.