3cb9fa26ef
This commit is an implementation of [RFC 565][rfc] which is a stabilization of the `std::fmt` module and the implementations of various formatting traits. Specifically, the following changes were performed: [rfc]: https://github.com/rust-lang/rfcs/blob/master/text/0565-show-string-guidelines.md * The `Show` trait is now deprecated, it was renamed to `Debug` * The `String` trait is now deprecated, it was renamed to `Display` * Many `Debug` and `Display` implementations were audited in accordance with the RFC and audited implementations now have the `#[stable]` attribute * Integers and floats no longer print a suffix * Smart pointers no longer print details that they are a smart pointer * Paths with `Debug` are now quoted and escape characters * The `unwrap` methods on `Result` now require `Display` instead of `Debug` * The `Error` trait no longer has a `detail` method and now requires that `Display` must be implemented. With the loss of `String`, this has moved into libcore. * `impl<E: Error> FromError<E> for Box<Error>` now exists * `derive(Show)` has been renamed to `derive(Debug)`. This is not currently warned about due to warnings being emitted on stage1+ While backwards compatibility is attempted to be maintained with a blanket implementation of `Display` for the old `String` trait (and the same for `Show`/`Debug`) this is still a breaking change due to primitives no longer implementing `String` as well as modifications such as `unwrap` and the `Error` trait. Most code is fairly straightforward to update with a rename or tweaks of method calls. [breaking-change] Closes #21436
53 lines
1.9 KiB
Rust
53 lines
1.9 KiB
Rust
// Copyright 2013 The Rust Project Developers. See the COPYRIGHT
|
|
// file at the top-level directory of this distribution and at
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. This file may not be copied, modified, or distributed
|
|
// except according to those terms.
|
|
|
|
//! HTML Escaping
|
|
//!
|
|
//! This module contains one unit-struct which can be used to HTML-escape a
|
|
//! string of text (for use in a format string).
|
|
|
|
use std::fmt;
|
|
|
|
/// Wrapper struct which will emit the HTML-escaped version of the contained
|
|
/// string when passed to a format string.
|
|
pub struct Escape<'a>(pub &'a str);
|
|
|
|
impl<'a> fmt::Display for Escape<'a> {
|
|
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
|
|
// Because the internet is always right, turns out there's not that many
|
|
// characters to escape: http://stackoverflow.com/questions/7381974
|
|
let Escape(s) = *self;
|
|
let pile_o_bits = s.as_slice();
|
|
let mut last = 0;
|
|
for (i, ch) in s.bytes().enumerate() {
|
|
match ch as char {
|
|
'<' | '>' | '&' | '\'' | '"' => {
|
|
try!(fmt.write_str(pile_o_bits.slice(last, i)));
|
|
let s = match ch as char {
|
|
'>' => ">",
|
|
'<' => "<",
|
|
'&' => "&",
|
|
'\'' => "'",
|
|
'"' => """,
|
|
_ => unreachable!()
|
|
};
|
|
try!(fmt.write_str(s));
|
|
last = i + 1;
|
|
}
|
|
_ => {}
|
|
}
|
|
}
|
|
|
|
if last < s.len() {
|
|
try!(fmt.write_str(pile_o_bits.slice_from(last)));
|
|
}
|
|
Ok(())
|
|
}
|
|
}
|