Struct fst::automaton::Str

pub struct Str<'a> { /* fields omitted */ }

An automaton that matches if the input equals to a specific string.

It can be used in combination with StartsWith to search strings starting with a given prefix.

extern crate fst;

use fst::{Automaton, IntoStreamer, Streamer, Set};
use fst::automaton::Str;

fn example() -> Result<(), Box<dyn std::error::Error>> {
    let paths = vec!["/home/projects/bar", "/home/projects/foo", "/tmp/foo"];
    let set = Set::from_iter(paths)?;

    // Build our prefix query.
    let prefix = Str::new("/home").starts_with();

    // Apply our query to the set we built.
    let mut stream = set.search(prefix).into_stream();

    let matches = stream.into_strs()?;
    assert_eq!(matches, vec!["/home/projects/bar", "/home/projects/foo"]);
    Ok(())
}

Implementations

impl<'a> Str<'a>

pub fn new(string: &'a str) -> Str<'a>

Constructs automaton that matches an exact string.

Trait Implementations

impl<'a> Automaton for Str<'a>

type State = Option<usize>

The type of the state used in the automaton.

fn start(&self) -> Option<usize>

Returns a single start state for this automaton.

fn is_match(&self, pos: &Option<usize>) -> bool

Returns true if and only if state is a match state.

fn can_match(&self, pos: &Option<usize>) -> bool

Returns true if and only if state can lead to a match in zero or more steps.

fn accept(&self, pos: &Option<usize>, byte: u8) -> Option<usize>

Return the next state given state and an input.

fn will_always_match(&self, _state: &Self::State) -> bool

Returns true if and only if state matches and must match no matter what steps are taken.

fn accept_eof(&self, _: &Self::State) -> Option<Self::State>

If applicable, return the next state when the end of a key is seen.

fn starts_with(self) -> StartsWith<Self> where
    Self: Sized, 

Returns an automaton that matches the strings that start with something this automaton matches.

fn union<Rhs: Automaton>(self, rhs: Rhs) -> Union<Self, Rhs> where
    Self: Sized, 

Returns an automaton that matches the strings matched by either this or the other automaton.

fn intersection<Rhs: Automaton>(self, rhs: Rhs) -> Intersection<Self, Rhs> where
    Self: Sized, 

Returns an automaton that matches the strings matched by both this and the other automaton.

fn complement(self) -> Complement<Self> where
    Self: Sized, 

Returns an automaton that matches the strings not matched by this automaton.

impl<'a> Clone for Str<'a>

fn clone(&self) -> Str<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Str<'a>

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

Formats the value using the given formatter.