fai

Documentation

Overview

Package fai implements FAI fasta sequence file index handling.

This package is deprecated. Please use the API-compatible version at github.com/biogo/hts/fai.

Index

• Variables
• type Index
  • func ReadFrom(r io.Reader) (idx Index, err error)
• type Record

Variables

var ErrNonUnique = fai.ErrNonUnique

Types

type Index

type Index = fai.Index

Index is an FAI index.

func ReadFrom

func ReadFrom(r io.Reader) (idx Index, err error)

ReadFrom returns an Index from the stream provided by an io.Reader or an error. If the input contains non-unique records the error is a csv.ParseError identifying the second non-unique record.

type Record

type Record = fai.Record

Record is a single FAI index record.