Struct diceprop::Set

pub struct Set<'a, S: Debug, D: DieOnce<S> + 'a> {
    pub name: &'a str,
    pub elem_die: D,
    // some fields omitted
}

A mathematical set that can be used to randomly choose Vars.

The elements of the set are represented by the generator. The set contains all elements that the generator could possibly generate.

Fields

name: &'a str

The name of the set.

elem_die: D

A generator for the elements of the set.

Implementations

impl<'a, S: Debug, D: DieOnce<S> + 'a> Set<'a, S, D>

pub fn new(name: &'a str, elem_die: D) -> Self

pub fn var_once(self, name: &'a str) -> impl DieOnce<Vars<'a, S, 1>>

Returns a generator that chooses a single variable from the set.

impl<'a, S: Debug, D: Die<S> + 'a> Set<'a, S, D>

pub fn as_ref<'b: 'a>(&'b self) -> Set<'a, S, &'b D>

Returns a Set with the same name and a reference to the original generator.

pub fn vars<const N: usize>(
    self,
    names: [&'a str; N]
) -> impl Die<Vars<'a, S, N>>

Returns a generator that chooses N variables from the set.