Struct Anchorizer

pub struct Anchorizer(/* private fields */);

Converts header strings to canonical, unique, but still human-readable, anchors.

To guarantee uniqueness, an anchorizer keeps track of the anchors it has returned; use one per output file.

Example

let mut anchorizer = Anchorizer::new();
// First "stuff" is unsuffixed.
assert_eq!("stuff".to_string(), anchorizer.anchorize("Stuff".to_string()));
// Second "stuff" has "-1" appended to make it unique.
assert_eq!("stuff-1".to_string(), anchorizer.anchorize("Stuff".to_string()));

Implementations

impl Anchorizer

pub fn new() -> Self

Construct a new anchorizer.

pub fn anchorize(&mut self, header: String) -> String

Returns a String that has been converted into an anchor using the GFM algorithm, which involves changing spaces to dashes, removing problem characters and, if needed, adding a suffix to make the resultant anchor unique.

let mut anchorizer = Anchorizer::new();
let source = "Ticks aren't in";
assert_eq!("ticks-arent-in".to_string(), anchorizer.anchorize(source.to_string()));