fastq

Documentation

Overview

Package fastq decodes and encodes fastq files.

This package uses the format described in: https://en.wikipedia.org/wiki/FASTQ_format

This package does not validate sequence and quality characters.

Index

• func File(file string) iter.Seq2[*Fastq, error]
• func Reader(r io.Reader) iter.Seq2[*Fastq, error]
• type Fastq
  • func (f *Fastq) MarshalText() ([]byte, error)
  • func (f *Fastq) Write(w io.Writer) error

Functions

func File

func File(file string) iter.Seq2[*Fastq, error]

File returns an iterator over fastq entries in a file.

func Reader

func Reader(r io.Reader) iter.Seq2[*Fastq, error]

Reader returns an iterator over fastq entries in a reader.

Types

type Fastq

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

Fastq is a single sequence in a fastq file.

func (*Fastq) MarshalText

func (f *Fastq) MarshalText() ([]byte, error)

MarshalText returns the textual representation of f in fastq format. Includes a trailing new line.

func (*Fastq) Write

func (f *Fastq) Write(w io.Writer) error

Write writes this entry in textual Fastq format to the given writer. Includes a trailing new line.