Struct Snippet 

pub struct Snippet<'a, T> { /* private fields */ }

A source view Element in a Group

If you do not have source available, see instead Origin

Snippets come in the following styles (T):

• With Annotations, see Snippet::annotation
• With Patchs, see Snippet::patch

Implementations

impl<'a, T: Clone> Snippet<'a, T>

pub fn source(source: impl Into<Cow<'a, str>>) -> Self

The source code to be rendered

Text passed to this function is considered “untrusted input”, as such all text is passed through a normalization function. Pre-styled text is not allowed to be passed to this function.

pub fn line_start(self, line_start: usize) -> Self

When manually folding, the sources line offset from the original start

pub fn path(self, path: impl Into<OptionCow<'a>>) -> Self

The location of the source (e.g. a path)

Text passed to this function is considered “untrusted input”, as such all text is passed through a normalization function. Pre-styled text is not allowed to be passed to this function.

pub fn fold(self, fold: bool) -> Self

Control whether lines without Annotations are shown

The default is fold(true), collapsing uninteresting lines.

See AnnotationKind::Visible to force specific spans to be shown.

impl<'a> Snippet<'a, Annotation<'a>>

pub fn annotation( self, annotation: Annotation<'a>, ) -> Snippet<'a, Annotation<'a>>

Highlight and describe a span of text within the source

pub fn annotations( self, annotation: impl IntoIterator<Item = Annotation<'a>>, ) -> Self

Highlight and describe spans of text within the source

impl<'a> Snippet<'a, Patch<'a>>

pub fn patch(self, patch: Patch<'a>) -> Snippet<'a, Patch<'a>>

Suggest to the user an edit to the source

pub fn patches(self, patches: impl IntoIterator<Item = Patch<'a>>) -> Self

Suggest to the user edits to the source

Trait Implementations

impl<'a, T: Clone> Clone for Snippet<'a, T>

fn clone(&self) -> Snippet<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Snippet<'a, T>

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

Formats the value using the given formatter.

impl<'a> From<Snippet<'a, Annotation<'a>>> for Element<'a>

fn from(value: Snippet<'a, Annotation<'a>>) -> Self

Converts to this type from the input type.

impl<'a> From<Snippet<'a, Patch<'a>>> for Element<'a>

fn from(value: Snippet<'a, Patch<'a>>) -> Self

Converts to this type from the input type.