fasta

Documentation

Overview

Package fasta decodes and encodes fasta files.

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

This package does not validate sequence characters.

Index

• type Fasta
  • func (f *Fasta) MarshalText() ([]byte, error)
• type Reader
  • func NewReader(r io.Reader) *Reader
  • func (r *Reader) Read() (*Fasta, error)

Types

type Fasta

type Fasta struct {
	Name     []byte // Sequence name (without the '>')
	Sequence []byte // Sequence
}

Fasta is a single sequence in a fasta file.

func (*Fasta) MarshalText

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

MarshalText returns the textual representation of f in fasta format. Includes a trailing new line. Always includes a name line, even for empty names. Sequence gets broken down into lines of length 80.

type Reader

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

A Reader reads sequences from a fasta stream.

func NewReader

func NewReader(r io.Reader) *Reader

NewReader returns a new fasta reader that reads from r.

func (*Reader) Read

func (r *Reader) Read() (*Fasta, error)

Read reads a single fasta sequence from a stream. Returns EOF only if nothing was read.