EdlibAlignResult

Struct EdlibAlignResult 

Source
#[repr(C)]
pub struct EdlibAlignResult { pub status: c_int, pub editDistance: c_int, pub endLocations: *mut c_int, pub startLocations: *mut c_int, pub numLocations: c_int, pub alignment: *mut c_uchar, pub alignmentLength: c_int, pub alphabetLength: c_int, }
Expand description

Container for results of alignment done by edlibAlign() function.

Fields§

§status: c_int

EDLIB_STATUS_OK or EDLIB_STATUS_ERROR. If error, all other fields will have undefined values.

§editDistance: c_int

-1 if k is non-negative and edit distance is larger than k.

§endLocations: *mut c_int

Array of zero-based positions in target optimal alignment paths end. If gap after query is penalized, gap counts as part of query (NW), otherwise not. Set to NULL if edit distance is larger than k. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().

§startLocations: *mut c_int

Array of zero-based positions in target where optimal alignment paths start, they correspond to endLocations. If gap before query is penalized, gap counts as part of query (NW), otherwise not. Set to NULL if not calculated or if edit distance is larger than k. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().

§numLocations: c_int

Number of end (and start) locations.

§alignment: *mut c_uchar

Alignment is found for first pair of start and end locations. Set to NULL if not calculated. Alignment is sequence of numbers: 0, 1, 2, 3. 0 stands for match. 1 stands for insertion to target. 2 stands for insertion to query. 3 stands for mismatch. Alignment aligns query to target from beginning of query till end of query. If gaps are not penalized, they are not in alignment. If you do not free whole result object using edlibFreeAlignResult(), do not forget to use free().

§alignmentLength: c_int

Length of alignment.

§alphabetLength: c_int

Number of different characters in query and target together.

Trait Implementations§

Source§

impl Clone for EdlibAlignResult

Source§

fn clone(&self) -> EdlibAlignResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EdlibAlignResult

Source§

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

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

impl Copy for EdlibAlignResult

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.