Struct rnglib::RNG

pub struct RNG {
    pub name: String,
    pub prefixes: Syllables,
    pub centers: Syllables,
    pub suffixes: Syllables,
    pub bad_syllables: Vec<String>,
}

RNG (Random Name Generator) is a library that generates random names based upon one of the available Languages.

Usage:

use rnglib::{RNG, Language};

let rng = RNG::try_from(&Language::Elven).unwrap();

let first_name = rng.generate_name();
let last_name = rng.generate_name();

println!("{}: {} {}", rng.name, first_name, last_name)

Fields

name: String

prefixes: Syllables

centers: Syllables

suffixes: Syllables

bad_syllables: Vec<String>

Implementations

impl RNG

pub fn new(language: &Language) -> Result<RNG, RNG>

Use if you want to return the RNG entity, even if there are issues with some of the syllables. Otherwise, use RNG::from.

Errors

Errors out if the language file is not able to be processed correctly.

pub fn new_from_file(filename: String) -> Result<RNG, RNGError>

Errors

Errors out if the language file is not able to be processed correctly.

pub fn random() -> RNG

pub fn empty(name: String) -> RNG

pub fn is_empty(&self) -> bool

pub fn is_valid(&self) -> bool

pub fn generate_name(&self) -> String

pub fn generate_names(&self, number: usize, is_short: bool) -> Vec<String>

Returns a vector of names based on the number passed in. Returns short weighted names if is_short is set to true.

pub fn generate_names_string(&self, n: usize, is_short: bool) -> String

pub fn generate_short(&self) -> String

pub fn generate_name_by_count(&self, count: u8) -> String

pub fn generate_syllables(&self) -> Syllables

pub fn generate_syllables_by_count(&self, syllable_count: u8) -> Syllables

Panics

Errors out if the language file is not able to be processed correctly.

pub fn syllables(&self) -> Syllables

Trait Implementations

impl Clone for RNG

fn clone(&self) -> RNG

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RNG

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

Formats the value using the given formatter.

impl From<&Language> for RNG

fn from(language: &Language) -> Self

Converts to this type from the input type.

impl PartialEq<RNG> for RNG

fn eq(&self, other: &RNG) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RNG