github.com/biogo/biogo@v1.0.4/io/seqio/fai/fai.go (about)

     1  // Copyright ©2013 The bíogo Authors. All rights reserved.
     2  // Use of this source code is governed by a BSD-style
     3  // license that can be found in the LICENSE file.
     4  
     5  // Package fai implements FAI fasta sequence file index handling.
     6  //
     7  // This package is deprecated. Please use the API-compatible version at github.com/biogo/hts/fai.
     8  package fai
     9  
    10  import (
    11  	"io"
    12  
    13  	"github.com/biogo/hts/fai"
    14  )
    15  
    16  var ErrNonUnique = fai.ErrNonUnique
    17  
    18  // Index is an FAI index.
    19  type Index = fai.Index
    20  
    21  // Record is a single FAI index record.
    22  type Record = fai.Record
    23  
    24  // ReadFrom returns an Index from the stream provided by an io.Reader or an error. If the input
    25  // contains non-unique records the error is a csv.ParseError identifying the second non-unique
    26  // record.
    27  func ReadFrom(r io.Reader) (idx Index, err error) {
    28  	return fai.ReadFrom(r)
    29  }