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

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

Functions

func File

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

File returns an iterator over fasta entries in a file.

func Reader

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

Reader returns an iterator over fasta entries in a reader.

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.

func (*Fasta) Write

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

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