Struct comrak::Anchorizer [−][src]
pub struct Anchorizer(_);
Converts header Strings to canonical, unique, but still human-readable, anchors.
To guarantee uniqueness, an anchorizer keeps track of the anchors it has returned. So, for example, to parse several MarkDown files, use a new anchorizer per file.
Example
use comrak::Anchorizer; 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
[src]
impl Anchorizer
[src]pub fn new() -> Self
[src]
Construct a new anchorizer.
pub fn anchorize(&mut self, header: String) -> String
[src]
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.
use comrak::Anchorizer; let mut anchorizer = Anchorizer::new(); let source = "Ticks aren't in"; assert_eq!("ticks-arent-in".to_string(), anchorizer.anchorize(source.to_string()));
Trait Implementations
impl Default for Anchorizer
[src]
impl Default for Anchorizer
[src]fn default() -> Anchorizer
[src]
Auto Trait Implementations
impl RefUnwindSafe for Anchorizer
impl RefUnwindSafe for Anchorizer
impl Send for Anchorizer
impl Send for Anchorizer
impl Sync for Anchorizer
impl Sync for Anchorizer
impl Unpin for Anchorizer
impl Unpin for Anchorizer
impl UnwindSafe for Anchorizer
impl UnwindSafe for Anchorizer