render_readme 0.11.0

Render Markdown or reStructuredText with syntax highlighting and image filtering similar to GitHub's
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

use std::borrow::Cow;
use std::time::Instant;

// TODO: add a deadline. timeout is not enough for pages with lots of images.

pub struct FilteredImage<'a> {
    pub src: Cow<'a, str>,
    pub srcset: Option<Cow<'a, str>>,
    pub width: Option<u32>,
    pub height: Option<u32>,
}

/// Callbacks for every image URL in the document
pub trait ImageFilter: Send + Sync + 'static {
    /// Ability to change the image URL
    /// Returns 1x image and 2x image, and width/height
    fn filter_url<'a>(&self, url: &'a str, wanted_width: Option<u32>, wanted_height: Option<u32>, _container_width: u32, deadline: Instant) -> FilteredImage<'a>;
}

impl ImageFilter for () {
    fn filter_url<'a>(&self, url: &'a str, width: Option<u32>, height: Option<u32>, _container_width: u32, _deadline: Instant) -> FilteredImage<'a> {
        FilteredImage {
            src: url.into(),
            srcset: None,
            width, height,
        }
    }
}