Sergey Konev
a8d83b9bab
Some checks failed
Continuous integration / Tests (push) Blocked by required conditions
Continuous integration / Tests (windows-latest) (push) Waiting to run
Continuous integration / Check clippy, formatting, and documentation (push) Failing after 20s
Continuous integration / Tests (ubuntu-latest) (push) Failing after 22s
Continuous integration / Check fuzzers (push) Failing after 18s
Continuous integration / Check mininum Rust version (push) Failing after 20s
|
||
---|---|---|
.. | ||
benches | ||
examples | ||
src | ||
tests | ||
.cargo-checksum.json | ||
Cargo.lock | ||
Cargo.toml | ||
LICENSE | ||
README.md |
Lorem Ipsum
Lipsum is a small Rust library for generating pseudo-Latin lorem ipsum filler text. This is a standard placeholder text used in publishing. It starts with:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat…
The text is generated using a Markov chain that has been trained on the first book in Cicero's work De finibus bonorum et malorum (On the ends of good and evil), of which the lorem ipsum text is a scrambled subset.
Usage
Add this to your Cargo.toml
:
[dependencies]
lipsum = "0.9"
Documentation
Please see the API documentation.
Getting Started
Use the lipsum
function to generate lorem ipsum text:
use lipsum::lipsum;
fn main() {
// Print 25 random words of lorem ipsum text.
println!("{}", lipsum(25));
}
This generates the lorem ipsum text show above:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco…
The text becomes random after 18 words, so you might not see exactly the same text.
Use lipsum_title
instead if you just need a short text suitable for
a document title or a section heading. The text generated by that
function looks like this:
Refugiendi et Omnino Rerum
Small words are kept uncapitalized and punctuation is stripped from all words.
Release History
This is a changelog with the most important changes in each release.
Version 0.9.1 (2024-03-13)
- #100: Add
lipsum_title_with_rng
function. - #102: Document MSRV in
Cargo.toml
. - #103: Enable dependabot updates.
Version 0.9.0 (2023-03-28)
- #90: Test minimum supported Rust version (Rust 1.56) in CI
- #91: Remove dependency on system randomness
Version 0.8.2 (2022-06-06)
- #84: Fix build error on Rust 1.56. Thanks @WorldSEnder for the report.
Version 0.8.1 (2022-04-19)
- #73: Add
lipsum_from_seed
and tweak capitalization. Thanks @reknih! - #77: Update to Rust 2021 edition.
Version 0.8.0 (2021-05-30)
The random number generator has been separated from the MarkovChain
implementation to allow using the same trained model to generate
multiple outputs with different seeds. Thanks @Diggsey!
Version 0.7.0 (2020-07-08)
-
The code has been updated to the Rust 2018 edition.
-
Each new release will only support the latest stable version of Rust. Trying to support older Rust versions has proven to be a fool's errand: our dependencies keep releasing new patch versions that require newer and newer versions of Rust.
-
#65: A new
lipsum_words_from_seed
function was added. It generates random but deterministic lorem ipsum text. This is useful in unit tests when you need fixed inputs.
Version 0.6.0 (2018-12-09)
The new lipsum_words
function can be used to generate random lorem
ipsum text that doesn't always start with "Lorem ipsum".
Dependencies were updated and the oldest supported version of Rust is now 1.22.
Version 0.5.0 (2018-04-22)
The new lipsum_title
function can be used to generate a short string
suitable for a document title or a section heading.
Dependencies were updated and the oldest supported version of Rust is now 1.17.
Version 0.4.0 (2017-09-24)
The generate
and generate_from
now always generate proper
sentences, meaning that they generate sentences that start with a
capital letter and end with .
or some other punctuation character.
Use iter
and iter_from
directly if you need more control.
Version 0.3.0 (2017-07-28)
Performance is improved by about 50% when generating text, but training the Markov chain now takes about twice as long as before.
The MarkovChain
struct has many new methods:
-
new_with_rng
makes it possible to specify the random number generator used by the Markov chain. Use this to get deterministic and thus reproducible output for tests.MarkovChain
now owns the RNG it uses and as a consequence, it has an extra type parameter. This is a breaking change if you used struct directly in your code. -
iter
andinto_from
return iterators over words in the Markov chain. Thegenerate
andgenerate_from
methods are now straight-forward convenience wrappers for the iterators. -
len
tells you the number of stats in the Markov chain andis_empty
tells you if the Markov chain is empty, meaning that it hasn't been trained on anything yet.
Version 0.2.0 (2017-07-10)
Rust version 1.6.0 is now supported. This is checked with TravisCI.
Version 0.1.0 (2017-07-2)
First public release.
License
Lipsum can be distributed according to the MIT license. Contributions will be accepted under the same license.