Enum SummaryText 

pub enum SummaryText {
    Escaped(String),
    Html(String),
}

Text destined for a summary element.

Examples

use actions_rs::{Summary, SummaryText};

let mut s = Summary::new();
s.heading(SummaryText::escaped("a<b"), 2)         // escaped
 .heading(SummaryText::html("<em>raw</em>"), 3);  // verbatim
assert_eq!(s.stringify(), "<h2>a&lt;b</h2>\n<h3><em>raw</em></h3>\n");

Variants

Escaped(String)

Escape HTML metacharacters before rendering.

Html(String)

Insert trusted HTML verbatim.

Implementations

impl SummaryText

pub fn escaped(text: impl Into<String>) -> Self

Escape text before rendering it into an element body.

Examples

use actions_rs::{Summary, SummaryText};
let mut s = Summary::new();
s.heading(SummaryText::escaped("1 < 2 & ok"), 1);
assert_eq!(s.stringify(), "<h1>1 &lt; 2 &amp; ok</h1>\n");

pub fn html(html: impl Into<String>) -> Self

Insert trusted HTML verbatim into an element body.

Examples

use actions_rs::{Summary, SummaryText};
let mut s = Summary::new();
s.heading(SummaryText::html("<strong>done</strong>"), 2);
assert_eq!(s.stringify(), "<h2><strong>done</strong></h2>\n");

Trait Implementations

impl Clone for SummaryText

fn clone(&self) -> SummaryText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryText

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

Formats the value using the given formatter.

impl From<&String> for SummaryText

fn from(text: &String) -> Self

Converts to this type from the input type.

impl From<&str> for SummaryText

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for SummaryText

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<SummaryText> for Cell

fn from(text: SummaryText) -> Self

Converts to this type from the input type.

impl PartialEq for SummaryText

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

impl StructuralPartialEq for SummaryText