Trait Reader 

pub trait Reader {
    // Required method
    fn read(
        &self,
        input: &str,
        options: &ReaderOptions,
    ) -> Result<Document, Error>;

    // Provided method
    fn read_media(
        &self,
        input: &str,
        options: &ReaderOptions,
    ) -> Result<(Document, MediaBag), Error> { ... }
}

Parses input text in some source format into the document model.

Required Methods

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

Parses input text into a document.

Errors

Propagates any error from parsing the input.

Provided Methods

fn read_media( &self, input: &str, options: &ReaderOptions, ) -> Result<(Document, MediaBag), Error>

Reads input into a document together with the embedded resources it references. The default carries no resources; a container format — a notebook with image outputs — overrides this to decode those bytes into the returned MediaBag, and implements read by discarding the bag.

Errors

Propagates any error from parsing the input.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Reader for CommonmarkReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for CsvReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

impl Reader for DokuwikiReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for HtmlReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for IpynbReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

fn read_media( &self, input: &str, options: &ReaderOptions, ) -> Result<(Document, MediaBag), Error>

impl Reader for JiraReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

impl Reader for JsonReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

impl Reader for LatexReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for ManReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for MediawikiReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for NativeReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

impl Reader for OpmlReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

impl Reader for OrgReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for RstReader

fn read(&self, input: &str, options: &ReaderOptions) -> Result<Document, Error>

impl Reader for TsvReader

fn read(&self, input: &str, _options: &ReaderOptions) -> Result<Document, Error>

Implementors