Struct Name 

pub struct Name { /* private fields */ }

Implementations

impl Name

pub fn add_part(&mut self, part: NamePart)

pub fn learn( &mut self, part_name: &str, sample_set: &SampleSet, ) -> Result<(), LearnError>

pub fn add_format(&mut self, name: &str, str: &str)

pub fn generate(&self, format_name: &str) -> Option<GeneratorIter<'_, SmallRng>>

Generate names with a fast RNG (SmallRng). This uses thread_rng() to seed, and may return none.

pub fn generate_part( &self, part_name: &str, ) -> Option<GeneratorIter<'_, SmallRng>>

Same as generate, but selecing a single part instead of using a format. You could always use NamePart directly, but then you wouldn’t get the same iterator syntax.

pub fn first_format_name(&self) -> Option<&str>

Get the first format name. Will return None if no formats exist.

pub fn parts(&self) -> impl Iterator<Item = &NamePart>

Iterate over the parts.

pub fn formats(&self) -> impl Iterator<Item = &NameFormat>

Iterate over the formats.

pub fn has_part_name(&self, name: &str) -> bool

Check if the generator has the requested part name.

pub fn has_format_name(&self, name: &str) -> bool

Check if the generator has the requested format name.

pub fn generate_seeded( &self, seed: u64, format_name: &str, ) -> Option<GeneratorIter<'_, SmallRng>>

Generate names with a fast RNG (SmallRng) using a seed. This is useful if your rand version differs and you want it to be dependent on external reproducable random data (e.g. if namegen is part of a bigger procedural generation pipeline).

pub fn generate_part_seeded( &self, seed: u64, part_name: &str, ) -> Option<GeneratorIter<'_, SmallRng>>

Generate a name part with a fast RNG (SmallRng) using a seed.

pub fn generate_with_thread_rng( &self, format_name: &str, ) -> Option<GeneratorIter<'_, ThreadRng>>

If you for some reason need a secure random generator….

pub fn generat_parte_with_thread_rng( &self, part_name: &str, ) -> Option<GeneratorIter<'_, ThreadRng>>

If you for some reason need a secure random generator….

pub fn validate(&self) -> Result<(), ValidationError>

pub fn new() -> Name

Trait Implementations

impl Clone for Name

fn clone(&self) -> Name

Returns a duplicate of the value.

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

Performs copy-assignment from source.