Skip to main content

FastaIndexEntry

Struct FastaIndexEntry 

Source
pub struct FastaIndexEntry {
    pub name: Vec<u8>,
    pub len: u64,
    pub offset: u64,
    pub line_bases: u64,
    pub line_width: u64,
}
Expand description

One .fai-style FASTA index entry.

offset, line_bases, and line_width follow the SAMtools .fai convention over the uncompressed FASTA byte stream. When built from BGZF input, virtual_offset stores the BGZF virtual offset for offset.

Fields§

§name: Vec<u8>

Reference name, using the first whitespace-delimited token after >.

§len: u64

Number of bases in the reference sequence.

§offset: u64

Uncompressed byte offset of the first sequence byte.

§line_bases: u64

Number of bases per full sequence line.

§line_width: u64

Number of bytes per full sequence line, including line ending bytes.

Implementations§

Source§

impl FastaIndexEntry

Source

pub fn sequence_offset(&self, pos: u64) -> Result<u64>

Return the uncompressed FASTA byte offset for a zero-based sequence position.

Coordinates are 0-based and do not include FASTA line separators.

Source

pub fn sequence_spans(&self, range: Range<u64>) -> Result<Vec<Range<u64>>>

Return physical FASTA byte spans covering a zero-based half-open sequence range.

Each returned span points only at sequence bytes and excludes physical newline bytes.

Trait Implementations§

Source§

impl Clone for FastaIndexEntry

Source§

fn clone(&self) -> FastaIndexEntry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FastaIndexEntry

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Eq for FastaIndexEntry

Source§

impl PartialEq for FastaIndexEntry

Source§

fn eq(&self, other: &FastaIndexEntry) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for FastaIndexEntry

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.