Struct Configuration

pub struct Configuration { /* private fields */ }

Configuration for the parser.

A configuration to correctly parse a real wiki can be created with Configuration::new. A configuration for testing and quick and dirty prototyping can be created with Default::default.

Implementations

impl Configuration

pub fn new(source: &ConfigurationSource<'_>) -> Self

Allocates and returns a new configuration based on the given site specific configuration.

pub fn parse_with_timeout<'a>( &self, wiki_text: &'a str, max_duration: Duration, ) -> Result<Output<'a>, ParseError<'a>>

Parses wiki text into structured data with a user defined timeout.

pub fn parse<'a>( &self, wiki_text: &'a str, ) -> Result<Output<'a>, ParseError<'a>>

Parses wiki text into structured data with a default timeout of 5 seconds.

pub fn parse_without_timeout<'a>( &self, wiki_text: &'a str, ) -> Result<Output<'a>, ParseError<'a>>

Parses wiki text into structured data with no time out. This function may run for extremely long lengths of time on certain articles

Trait Implementations

impl Default for Configuration

fn default() -> Self

Allocates and returns a configuration suitable for testing and quick and dirty prototyping. For correctly parsing an actual wiki, please get the correct site configuration for that particular wiki.