6 releases
0.3.1 | Nov 20, 2020 |
---|---|
0.3.0 | Nov 20, 2020 |
0.2.0 | Oct 20, 2020 |
0.1.2 | Oct 20, 2020 |
#2044 in Parser implementations
27 downloads per month
Used in 2 crates
28KB
438 lines
mc-legacy-formatting
A parser for Minecraft's legacy formatting system, created with careful attention to the quirks of the vanilla client's implementation.
Features
- Iterator-based, non-allocating parser
- Supports
#![no_std]
usage (withdefault-features
set tofalse
) - Implements the entire spec as well as vanilla client quirks (such as handling
of whitespace with the
STRIKETHROUGH
style) - Helpers for pretty-printing the parsed
Span
s to the terminal - Support for parsing any start character for the formatting codes (vanilla
uses
§
while many community tools use&
)
Examples
Using SpanIter
:
use mc_legacy_formatting::{SpanExt, Span, Color, Styles};
let s = "§4This will be dark red §oand italic";
let mut span_iter = s.span_iter();
assert_eq!(span_iter.next().unwrap(), Span::new_styled("This will be dark red ", Color::DarkRed, Styles::empty()));
assert_eq!(span_iter.next().unwrap(), Span::new_styled("and italic", Color::DarkRed, Styles::ITALIC));
assert!(span_iter.next().is_none());
With a custom start character:
use mc_legacy_formatting::{SpanExt, Span, Color, Styles};
let s = "&6It's a lot easier to type &b& &6than &b§";
let mut span_iter = s.span_iter().with_start_char('&');
assert_eq!(span_iter.next().unwrap(), Span::new_styled("It's a lot easier to type ", Color::Gold, Styles::empty()));
assert_eq!(span_iter.next().unwrap(), Span::new_styled("& ", Color::Aqua, Styles::empty()));
assert_eq!(span_iter.next().unwrap(), Span::new_styled("than ", Color::Gold, Styles::empty()));
assert_eq!(span_iter.next().unwrap(), Span::new_styled("§", Color::Aqua, Styles::empty()));
assert!(span_iter.next().is_none());
MSRV
The Minimum Supported Rust Version is currently 1.48.0. This will be bumped to the latest stable version of Rust when needed.
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~0–9.5MB
~52K SLoC