1 unstable release

Uses old Rust 2015

0.3.1 Apr 2, 2017

#12 in #html-string

Download history 79828/week @ 2024-11-17 60867/week @ 2024-11-24 82690/week @ 2024-12-01 67259/week @ 2024-12-08 70728/week @ 2024-12-15 37450/week @ 2024-12-22 42131/week @ 2024-12-29 73663/week @ 2025-01-05 80986/week @ 2025-01-12 71947/week @ 2025-01-19 85905/week @ 2025-01-26 100945/week @ 2025-02-02 94792/week @ 2025-02-09 84623/week @ 2025-02-16 121658/week @ 2025-02-23 116761/week @ 2025-03-02

427,107 downloads per month
Used in 241 crates (49 directly)

Apache-2.0 / MIT / MPL-2.0

54KB
606 lines

A HTML entity encoding library for Rust

Build Status

Example usage

All example assume a extern crate htmlescape; and use htmlescape::{relevant functions here}; is present.

###Encoding htmlescape::encode_minimal() encodes an input string using a minimal set of HTML entities.

let title = "Cats & dogs";
let tag = format!("<title>{}</title>", encode_minimal(title));
assert_eq!(tag.as_slice(), "<title>Cats &amp; dogs</title>");

There is also a htmlescape::encode_attribute() function for encoding strings that are to be used as html attribute values.

###Decoding htmlescape::decode_html() decodes an encoded string, replacing HTML entities with the corresponding characters. Named, hex, and decimal entities are supported. A Result value is returned, with either the decoded string in Ok, or an error in Err.

let encoded = "Cats&#x20;&amp;&#32;dogs";
let decoded = match decode_html(encoded) {
  Err(reason) => panic!("Error {:?} at character {}", reason.kind, reason.position),
  Ok(s) => s
};
assert_eq!(decoded.as_slice(), "Cats & dogs");

###Avoiding allocations Both the encoding and decoding functions are available in forms that take a Writer for output rather than returning an String. These version can be used to avoid allocation and copying if the returned String was just going to be written to a Writer anyway.

No runtime deps