Struct Include 

pub struct Include<'a> {
    pub path: &'a Path,
    pub stem: &'a str,
    pub doc: Comment<'a>,
}

A single include.

Fields

path: &'a Path

The path to the included file.

stem: &'a str

The file stem of path.

doc: Comment<'a>

Implementations

impl<'a> Include<'a>

pub fn builder() -> IncludeBuilder<'a, ((), (), ())>

Create a builder for building Include. On the builder, call .path(...), .stem(...), .doc(...)(optional) to set the values of the fields (they accept Into values). Finally, call .build() to create the instance of Include.

Trait Implementations

impl<'a> Clone for Include<'a>

fn clone(&self) -> Include<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Include<'a>

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

Formats the value using the given formatter.

impl<'a> From<(&'a Path, &'a str, Comment<'a>)> for Include<'a>

fn from(original: (&'a Path, &'a str, Comment<'a>)) -> Include<'a>

Converts to this type from the input type.

impl<'a> Hash for Include<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Include<'a>

fn cmp(&self, other: &Include<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Include<'a>

fn eq(&self, other: &Include<'a>) -> 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<'a> PartialOrd for Include<'a>

fn partial_cmp(&self, other: &Include<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for Include<'a>

impl<'a> StructuralPartialEq for Include<'a>