Struct Brief 

pub struct Brief { /* private fields */ }

Like Comment, but single-line.

Implementations

impl Brief

pub fn new() -> Self

Creates an empty comment.

pub fn plain<S: ToString>(self, text: S) -> Self

Adds a piece of plain text to the comment.

pub fn link<S: ToString>(self, text: S, path: PathBuf) -> Self

Adds a piece of text to the comment that links to the given path.

pub fn url<S: ToString, U: ToString>(self, text: S, url: U) -> Self

Adds a piece of text to the comment that links to the given URL.

pub fn push(&mut self, span: Span)

Pushes a span into this brief.

pub fn extend(&mut self, other: Brief)

Pushes a whole other brief’s worth of elements into this brief.

pub fn spans(&self) -> &[Span]

Returns the slice of spans that comprise the brief.

Trait Implementations

impl Clone for Brief

fn clone(&self) -> Brief

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Brief

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

Formats the value using the given formatter.

impl Default for Brief

fn default() -> Brief

Returns the “default value” for a type.

impl Display for Brief

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

Formats the value using the given formatter.

impl From<&Brief> for Comment

fn from(node: &Brief) -> Self

Converts to this type from the input type.

impl From<Brief> for Comment

fn from(brief: Brief) -> Self

Converts to this type from the input type.

impl From<String> for Brief

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq for Brief

fn eq(&self, other: &Brief) -> 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 Eq for Brief

impl StructuralPartialEq for Brief