rust/src/librustdoc/externalfiles.rs
2016-10-09 00:17:50 -04:00

91 lines
2.9 KiB
Rust

// Copyright 2014 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.
use std::fs::File;
use std::io::prelude::*;
use std::io;
use std::path::Path;
use std::str;
#[derive(Clone)]
pub struct ExternalHtml{
/// Content that will be included inline in the <head> section of a
/// rendered Markdown file or generated documentation
pub in_header: String,
/// Content that will be included inline between <body> and the content of
/// a rendered Markdown file or generated documentation
pub before_content: String,
/// Content that will be included inline between the content and </body> of
/// a rendered Markdown file or generated documentation
pub after_content: String
}
impl ExternalHtml {
pub fn load(in_header: &[String], before_content: &[String], after_content: &[String])
-> Option<ExternalHtml> {
load_external_files(in_header)
.and_then(|ih|
load_external_files(before_content)
.map(|bc| (ih, bc))
)
.and_then(|(ih, bc)|
load_external_files(after_content)
.map(|ac| (ih, bc, ac))
)
.map(|(ih, bc, ac)|
ExternalHtml {
in_header: ih,
before_content: bc,
after_content: ac,
}
)
}
}
pub enum LoadStringError {
ReadFail,
BadUtf8,
}
pub fn load_string<P: AsRef<Path>>(file_path: P) -> Result<String, LoadStringError> {
let file_path = file_path.as_ref();
let mut contents = vec![];
let result = File::open(file_path)
.and_then(|mut f| f.read_to_end(&mut contents));
if let Err(e) = result {
let _ = writeln!(&mut io::stderr(),
"error reading `{}`: {}",
file_path.display(), e);
return Err(LoadStringError::ReadFail);
}
match str::from_utf8(&contents) {
Ok(s) => Ok(s.to_string()),
Err(_) => {
let _ = writeln!(&mut io::stderr(),
"error reading `{}`: not UTF-8",
file_path.display());
Err(LoadStringError::BadUtf8)
}
}
}
fn load_external_files(names: &[String]) -> Option<String> {
let mut out = String::new();
for name in names {
let s = match load_string(name) {
Ok(s) => s,
Err(_) => return None,
};
out.push_str(&s);
out.push('\n');
}
Some(out)
}