Struct suffix_array::SuffixArray

pub struct SuffixArray<'s> { /* fields omitted */ }

Suffix array for searching byte strings.

Methods

impl<'s> SuffixArray<'s>

pub fn new(s: &'s [u8]) -> Self

pub fn set(&mut self, s: &'s [u8])

pub fn fit(&mut self)

pub fn len(&self) -> usize

Length of the underlying byte string.

pub fn is_empty(&self) -> bool

Test if the underlying byte string is empty.

pub fn into_parts(self) -> (&'s [u8], Vec<u32>)

Take out the suffix array and its corresponding byte string.

pub fn from_parts(s: &'s [u8], sa: Vec<u32>) -> Option<Self>

Compose existed suffix array and its corresponding byte string together, and checks the integrity.

pub unsafe fn unchecked_from_parts(s: &'s [u8], sa: Vec<u32>) -> Self

Compose existed suffix array and its corresponding byte string together without integrity check.

pub fn contains(&self, sub: &[u8]) -> bool

Test if contains given sub-string.

pub fn search_all(&self, sub: &[u8]) -> &[u32]

Search for all the unsorted overlapping occurrence of given sub-string.

pub fn search_lcp(&self, pat: &[u8]) -> Range<usize>

Search for one sub-string that has the longest common prefix of the given pattern.

pub fn dump<W: Write>(&self, file: W) -> Result<()>

Write the suffix array (without the byte string).

pub fn dump_file<P: AsRef<Path>>(&self, name: P) -> Result<()>

Create a file and write the suffix array (without the byte string).

pub fn dump_bytes(&self) -> Result<Vec<u8>>

Dump the suffix array as bytes (without the byte string).

pub unsafe fn unchecked_load<R: Read>(s: &'s [u8], file: R) -> Result<Self>

Read suffix array without integrity check.

pub fn load<R: Read>(s: &'s [u8], file: R) -> Result<Self>

Read suffix array.

pub unsafe fn unchecked_load_file<P: AsRef<Path>>(
    s: &'s [u8],
    name: P
) -> Result<Self>

Read suffix array from a file without integrity check.

pub fn load_file<P: AsRef<Path>>(s: &'s [u8], name: P) -> Result<Self>

Read suffix array from a file.

pub unsafe fn unchecked_load_bytes(s: &'s [u8], bytes: &[u8]) -> Result<Self>

Load suffix array from bytes without integrity check.

pub fn load_bytes(s: &'s [u8], bytes: &[u8]) -> Result<Self>

Load suffix array from bytes.

Trait Implementations

impl<'s> AsRef<[u8]> for SuffixArray<'s>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'s> Clone for SuffixArray<'s>

fn clone(&self) -> SuffixArray<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> From<SuffixArray<'s>> for Vec<u32>

fn from(sa: SuffixArray<'s>) -> Vec<u32>

Performs the conversion.