Enum FileComment 

pub(crate) enum FileComment {
    InnerDoc(Box<str>),
    Line(Box<str>),
}

A structurally attached comment rendered before a generated Rust file.

Variants

InnerDoc(Box<str>)

Line(Box<str>)

Implementations

impl FileComment

pub(crate) fn inner_doc( text: impl Into<Box<str>>, ) -> Result<Self, RustSourceError>

pub(crate) fn line(text: impl Into<Box<str>>) -> Result<Self, RustSourceError>

fn new( text: impl Into<Box<str>>, constructor: impl FnOnce(Box<str>) -> Self, ) -> Result<Self, RustSourceError>

Trait Implementations

impl Clone for FileComment

fn clone(&self) -> FileComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileComment

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

Formats the value using the given formatter.