Struct CorpusSpec 

pub struct CorpusSpec {
    pub pages: usize,
    pub seed: u64,
    pub words_per_page: usize,
}

Shape of a synthetic corpus.

Examples

use ssg::bench_corpus::CorpusSpec;
// The published sizes: 1K, 10K, 100K.
let spec = CorpusSpec::new(1_000);
assert_eq!(spec.pages, 1_000);
assert_eq!(spec.seed, CorpusSpec::DEFAULT_SEED);

Fields

pages: usize

Number of Markdown pages to write.

seed: u64

Seed for the content generator. Fixed by default so two runs of the same size produce byte-identical input.

words_per_page: usize

Approximate words per page body.

Implementations

impl CorpusSpec

pub const DEFAULT_SEED: u64 = 0x5353_4720_4265_6e63

The seed used for published figures. Changing it invalidates comparison with every previously published number, so it is a constant rather than a parameter with a default.

pub const fn new(pages: usize) -> Self

A corpus of pages pages at the published seed and body length.

pub const fn with_seed(self, seed: u64) -> Self

Overrides the seed, for tests that need two distinguishable corpora.

Trait Implementations

impl Clone for CorpusSpec

fn clone(&self) -> CorpusSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CorpusSpec

impl Debug for CorpusSpec

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

Formats the value using the given formatter.

impl Eq for CorpusSpec

impl PartialEq for CorpusSpec

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CorpusSpec