Skip to main content

FastaImporter

Struct FastaImporter 

Source
pub struct FastaImporter { /* private fields */ }
Expand description

Imports FASTA records and emits SBOL 3 Documents.

FastaImporter::new takes the namespace IRI that the resulting SBOL 3 top-level objects will be rooted under — typically the owning lab or repository (e.g. https://example.org/lab). Component identities are derived as {namespace}/{record-id}.

By default, the alphabet of each record is detected automatically from the sequence text. Call FastaImporter::with_alphabet to override that detection when the data is ambiguous.

Implementations§

Source§

impl FastaImporter

Source

pub fn new(namespace: impl AsRef<str>) -> Result<Self, ImportError>

Builds a new importer scoped to the supplied namespace IRI.

Source

pub fn with_alphabet(self, alphabet: Alphabet) -> Self

Skips alphabet detection and forces every record to be imported as the supplied Alphabet.

Source

pub fn read<R: Read>( &self, reader: R, ) -> Result<(Document, ImportReport), ImportError>

Reads every record from the supplied reader and returns one SBOL 3 Document containing the emitted Components + Sequences plus an ImportReport tallying what was produced.

Source

pub fn read_str( &self, input: &str, ) -> Result<(Document, ImportReport), ImportError>

Reads from a string slice.

Source

pub fn read_path( &self, path: impl AsRef<Path>, ) -> Result<(Document, ImportReport), ImportError>

Reads from a file on disk (.fasta / .fa / .fna / .faa — the importer doesn’t actually care about the extension).

Trait Implementations§

Source§

impl Clone for FastaImporter

Source§

fn clone(&self) -> FastaImporter

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 FastaImporter

Source§

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

Formats the value using the given formatter. Read more

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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V