Use Default
trait for Generator & Name types.
Breaking API: the function formerly known as `Generator::default(Name::Plain)` has been changed to `Generator::with_naming(Name::Plain)` as Generator now implements the Default trait.
This commit is contained in:
parent
858f336713
commit
938ce9a19d
@ -21,13 +21,13 @@ fn main() {
|
|||||||
.get_matches();
|
.get_matches();
|
||||||
|
|
||||||
let amount = value_t!(matches.value_of("amount"), usize).unwrap_or(1);
|
let amount = value_t!(matches.value_of("amount"), usize).unwrap_or(1);
|
||||||
let naming = if matches.is_present("number") {
|
let naming: Name = if matches.is_present("number") {
|
||||||
Name::Numbered
|
Name::Numbered
|
||||||
} else {
|
} else {
|
||||||
Name::Plain
|
Default::default()
|
||||||
};
|
};
|
||||||
|
|
||||||
let mut generator = Generator::default(naming);
|
let mut generator = Generator::with_naming(naming);
|
||||||
for _ in 0..amount {
|
for _ in 0..amount {
|
||||||
println!("{}", generator.next().unwrap());
|
println!("{}", generator.next().unwrap());
|
||||||
}
|
}
|
||||||
|
32
src/lib.rs
32
src/lib.rs
@ -27,9 +27,9 @@
|
|||||||
//! a name:
|
//! a name:
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! use names::{Generator, Name};
|
//! use names::Generator;
|
||||||
//!
|
//!
|
||||||
//! let mut generator = Generator::default(Name::Plain);
|
//! let mut generator: Generator = Default::default();
|
||||||
//! println!("Your project is: {}", generator.next().unwrap());
|
//! println!("Your project is: {}", generator.next().unwrap());
|
||||||
//! // #=> "Your project is: rusty-nail"
|
//! // #=> "Your project is: rusty-nail"
|
||||||
//! ```
|
//! ```
|
||||||
@ -40,7 +40,7 @@
|
|||||||
//! ```
|
//! ```
|
||||||
//! use names::{Generator, Name};
|
//! use names::{Generator, Name};
|
||||||
//!
|
//!
|
||||||
//! let mut generator = Generator::default(Name::Numbered);
|
//! let mut generator = Generator::with_naming(Name::Numbered);
|
||||||
//! println!("Your project is: {}", generator.next().unwrap());
|
//! println!("Your project is: {}", generator.next().unwrap());
|
||||||
//! // #=> "Your project is: pushy-pencil-5602"
|
//! // #=> "Your project is: pushy-pencil-5602"
|
||||||
//! ```
|
//! ```
|
||||||
@ -52,11 +52,11 @@
|
|||||||
//! this returns only one result:
|
//! this returns only one result:
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! use names::{Generator, Name};
|
//! use names::Generator;
|
||||||
//!
|
//!
|
||||||
//! let adjectives = &["imaginary"];
|
//! let adjectives = &["imaginary"];
|
||||||
//! let nouns = &["roll"];
|
//! let nouns = &["roll"];
|
||||||
//! let mut generator = Generator::new(adjectives, nouns, Name::Plain);
|
//! let mut generator = Generator::new(adjectives, nouns, Default::default());
|
||||||
//!
|
//!
|
||||||
//! assert_eq!("imaginary-roll", generator.next().unwrap());
|
//! assert_eq!("imaginary-roll", generator.next().unwrap());
|
||||||
//! ```
|
//! ```
|
||||||
@ -77,14 +77,18 @@ pub enum Name {
|
|||||||
Numbered
|
Numbered
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl Default for Name {
|
||||||
|
fn default() -> Name { Name::Plain }
|
||||||
|
}
|
||||||
|
|
||||||
/// A random name generator which combines an adjective, a noun, and an
|
/// A random name generator which combines an adjective, a noun, and an
|
||||||
/// optional number
|
/// optional number
|
||||||
///
|
///
|
||||||
/// A `Generator` takes a slice of adjective and noun words strings and has
|
/// A `Generator` takes a slice of adjective and noun words strings and has
|
||||||
/// a naming strategy (with or without a number appended).
|
/// a naming strategy (with or without a number appended).
|
||||||
pub struct Generator<'a> {
|
pub struct Generator<'a> {
|
||||||
adjectives: &'a [&'static str],
|
adjectives: &'a [&'a str],
|
||||||
nouns: &'a [&'static str],
|
nouns: &'a [&'a str],
|
||||||
naming: Name,
|
naming: Name,
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -105,8 +109,8 @@ impl<'a> Generator<'a> {
|
|||||||
/// assert_eq!("sassy-clocks", generator.next().unwrap());
|
/// assert_eq!("sassy-clocks", generator.next().unwrap());
|
||||||
/// ```
|
/// ```
|
||||||
pub fn new(
|
pub fn new(
|
||||||
adjectives: &'a [&'static str],
|
adjectives: &'a [&'a str],
|
||||||
nouns: &'a [&'static str],
|
nouns: &'a [&'a str],
|
||||||
naming: Name
|
naming: Name
|
||||||
) -> Generator<'a> {
|
) -> Generator<'a> {
|
||||||
Generator {
|
Generator {
|
||||||
@ -122,11 +126,11 @@ impl<'a> Generator<'a> {
|
|||||||
/// ```
|
/// ```
|
||||||
/// use names::{Generator, Name};
|
/// use names::{Generator, Name};
|
||||||
///
|
///
|
||||||
/// let mut generator = Generator::default(Name::Plain);
|
/// let mut generator = Generator::with_naming(Name::Plain);
|
||||||
///
|
///
|
||||||
/// println!("My new name is: {}", generator.next().unwrap());
|
/// println!("My new name is: {}", generator.next().unwrap());
|
||||||
/// ```
|
/// ```
|
||||||
pub fn default(naming: Name) -> Generator<'a> {
|
pub fn with_naming(naming: Name) -> Generator<'a> {
|
||||||
Generator::new(
|
Generator::new(
|
||||||
adjectives::LIST,
|
adjectives::LIST,
|
||||||
nouns::LIST,
|
nouns::LIST,
|
||||||
@ -146,6 +150,12 @@ impl<'a> Generator<'a> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<'a> Default for Generator<'a> {
|
||||||
|
fn default() -> Generator<'a> {
|
||||||
|
Generator::new(adjectives::LIST, nouns::LIST, Default::default())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
impl<'a> Iterator for Generator<'a> {
|
impl<'a> Iterator for Generator<'a> {
|
||||||
type Item = String;
|
type Item = String;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user