Skip to main content

AutoSlug

Struct AutoSlug 

Source
pub struct AutoSlug { /* private fields */ }
Expand description

Generates URL-safe slugs for headings and sets the id field.

Slug algorithm:

  1. Extract plain text from heading children
  2. Lowercase, replace non-alphanumeric runs with -, trim -
  3. Deduplicate by appending -1, -2, etc.

§Example

use rdx_transform::{Pipeline, AutoSlug, parse};

let root = Pipeline::new().add(AutoSlug::new()).run("# Hello World\n");
// heading.id == Some("hello-world")

Implementations§

Source§

impl AutoSlug

Source

pub fn new() -> Self

Trait Implementations§

Source§

impl Default for AutoSlug

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Transform for AutoSlug

Source§

fn name(&self) -> &str

A short identifier for this transform (used in error messages / debugging).
Source§

fn transform(&self, root: &mut Root, _source: &str)

Apply the transform to the AST. source is the original document text, available for transforms that need to reference raw content.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.