Struct mudders::SymbolTable

pub struct SymbolTable(_);

The functionality of the crate lives here.

A symbol table is, internally, a vector of valid ASCII bytes that are used to generate lexicographically evenly-spaced strings.

Methods

impl SymbolTable

pub fn new(source: &[u8]) -> Result<Self, CreationError>

Creates a new symbol table from the given byte slice. The slice is internally sorted using .sort().

An error is returned if one of the given bytes is out of ASCII range.

pub fn from_chars(source: &[char]) -> Result<Self, CreationError>

Creates a new symbol table from the given characters. The slice is internally sorted using .sort().

An error is returned if one of the given characters is not ASCII.

pub fn alphabet() -> Self

Returns a SymbolTable which contains the lowercase latin alphabet ([a-z]).

pub fn mudder(
    &self,
    a: &str,
    b: &str,
    amount: NonZeroUsize
) -> Result<Vec<String>, GenerationError>

Generate amount strings that lexicographically sort between start and end. The algorithm will try to make them as evenly-spaced as possible.

When both parameters are empty strings, amount new strings that are in lexicographical order are returned.

If parameter b is lexicographically before a, they are swapped internally.

// Using the included alphabet table
let table = SymbolTable::alphabet();
// Generate 10 strings from scratch
let results = table.mudder("", "", NonZeroUsize::new(10).unwrap()).unwrap();
assert!(results.len() == 10);
// results should look something like ["b", "d", "f", ..., "r", "t"]

pub fn mudder_one(&self, a: &str, b: &str) -> Result<String, GenerationError>

Convenience wrapper around mudder to generate exactly one string.

Safety

This function calls NonZeroUsize::new_unchecked(1).

pub fn generate(
    &self,
    amount: NonZeroUsize
) -> Result<Vec<String>, GenerationError>

Convenience wrapper around mudder to generate an amount of fresh strings.

SymbolTable.generate(amount) is equivalent to SymbolTable.mudder("", "", amount).

Trait Implementations

impl Clone for SymbolTable

fn clone(&self) -> SymbolTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolTable

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

Formats the value using the given formatter.

impl FromStr for SymbolTable

type Err = CreationError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, CreationError>

Parses a string s to return a value of this type.