FaiRecord

Mojo struct 🡭

FaiRecord

@memory_only
struct FaiRecord

Single entry from a FASTA/FASTQ .fai index file.

Columns (TAB-delimited): 1. NAME – reference sequence name 2. LENGTH – total length of the reference (bases) 3. OFFSET – byte offset of the first base in the FASTA/FASTQ file 4. LINEBASES – number of bases per sequence line 5. LINEWIDTH – number of bytes per sequence line (including newline) 6. QUALOFFSET – (FASTQ only) byte offset of first quality character or None for FASTA 5-column indexes.

Fields

• Name (BString)
• Length (Int64)
• Offset (Int64)
• LineBases (Int64)
• LineWidth (Int64)
• QualOffset (Optional[Int64])

Implemented traits

AnyType, Copyable, ImplicitlyDestructible, Movable, Sized, Writable

Methods

name

def name(ref self) -> String

Args:

• self (Self)

Returns:

String

length

def length(self) -> Int64

Args:

• self (Self)

Returns:

Int64

offset

def offset(self) -> Int64

Args:

• self (Self)

Returns:

Int64

line_bases

def line_bases(self) -> Int64

Args:

• self (Self)

Returns:

Int64

line_width

def line_width(self) -> Int64

Args:

• self (Self)

Returns:

Int64

qual_offset

def qual_offset(self) -> Optional[Int64]

Args:

• self (Self)

Returns:

Optional

__len__

def __len__(self) -> Int

Return the reference length as an Int.

Args:

• self (Self)

Returns:

Int

write_to

def write_to[w: Writer](self, mut writer: w)

Write this record as a single .fai line.

Parameters:

• w (Writer)

Args:

• self (Self)
• writer (w)