Struct PodDoc 

pub struct PodDoc {
    pub name: Option<String>,
    pub synopsis: Option<String>,
    pub description: Option<String>,
    pub methods: HashMap<String, String>,
    pub arguments: Option<String>,
    pub return_values: Option<String>,
    pub examples: Option<String>,
    pub see_also: Option<String>,
}

Extracted POD documentation from a Perl module.

Fields

name: Option<String>

Module name and optional one-line description from =head1 NAME.

synopsis: Option<String>

Usage example from =head1 SYNOPSIS.

description: Option<String>

First paragraph of =head1 DESCRIPTION.

methods: HashMap<String, String>

Method/function docs keyed by name, from =head2 method_name.

arguments: Option<String>

Parameters from =head1 ARGUMENTS.

return_values: Option<String>

Return value documentation from =head1 RETURN VALUES.

examples: Option<String>

Usage examples from =head1 EXAMPLES.

see_also: Option<String>

Related modules from =head1 SEE ALSO.

Implementations

impl PodDoc

pub fn is_empty(&self) -> bool

Returns true if no documentation was extracted.

Trait Implementations

impl Clone for PodDoc

fn clone(&self) -> PodDoc

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PodDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PodDoc

fn default() -> PodDoc

Returns the “default value” for a type.

impl Eq for PodDoc

impl PartialEq for PodDoc

fn eq(&self, other: &PodDoc) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PodDoc