Struct Cell 

pub struct Cell { /* private fields */ }

A table cell. Use Cell::header for <th>; colspan/rowspan map to the matching HTML attributes. Cell content is escaped unless you pass SummaryText::html.

Examples

use actions_rs::{Cell, Summary};
let mut s = Summary::new();
s.table([vec![Cell::header("Name"), Cell::new("value")]]);
assert!(s.stringify().contains(r#"<th colspan="1" rowspan="1">Name</th>"#));

Implementations

impl Cell

pub fn new(data: impl Into<SummaryText>) -> Self

A <td> cell.

Examples

use actions_rs::{Cell, Summary};
let mut s = Summary::new();
s.table([vec![Cell::new("x")]]);
assert_eq!(s.stringify(), "<table><tr><td colspan=\"1\" rowspan=\"1\">x</td></tr></table>\n");

Examples found in repository

examples/demo.rs (line 68)

fn main() {
    log::info(format!(
        "in GitHub Actions: {} | CI: {} | step-debug: {}",
        env::is_github_actions(),
        env::is_ci(),
        log::is_debug()
    ));

    let ctx = actions_rs::Context::new();
    log::info(format!(
        "repo={:?} ref={:?} sha={:?}",
        ctx.repository(),
        ctx.ref_name(),
        ctx.sha()
    ));

    // Located annotation with a line range — should print:
    // ::warning title=demo,file=src/lib.rs,line=10,endLine=12::heads up
    Annotation::new()
        .file("src/lib.rs")
        .line(10)
        .end_line(12)
        .title("demo")
        .warning("heads up: this span looks suspicious");

    // Escaping check: newline in data, colon/comma in a property.
    Annotation::new()
        .title("type: mismatch, really")
        .error("line one\nline two");

    let total = log::group("expensive step", || {
        log::info("...working...");
        2 + 2
    });
    log::info(format!("group returned {total}"));

    actions_rs::warning!("formatted macro: {} items left", 7);

    output::set_output("answer", 42).expect("set_output");
    match output::export_var("DEMO_FLAG", true) {
        Ok(()) => {}
        Err(actions_rs::Error::UnavailableFileCommand {
            var: "GITHUB_ENV", ..
        }) => {
            log::info("GITHUB_ENV unset; skipping export_var in local demo");
        }
        Err(err) => panic!("export_var: {err}"),
    }

    let mut summary = Summary::new();
    summary
        .heading("Demo Report", 2)
        .raw("Built by the `demo` example.", true)
        .table([
            vec![Cell::header("Check"), Cell::header("Result")],
            vec![Cell::new("clippy"), Cell::new("pass")],
            vec![Cell::new("tests"), Cell::new("36 pass")],
        ])
        .code_block("cargo test", Some("sh"));
    summary.write().expect("write summary");
    log::info("summary written (if GITHUB_STEP_SUMMARY was set)");
}

pub fn header(data: impl Into<SummaryText>) -> Self

A <th> header cell.

Examples

use actions_rs::{Cell, Summary};
let mut s = Summary::new();
s.table([vec![Cell::header("Col")]]);
assert_eq!(s.stringify(), "<table><tr><th colspan=\"1\" rowspan=\"1\">Col</th></tr></table>\n");

Examples found in repository

examples/demo.rs (line 67)

fn main() {
    log::info(format!(
        "in GitHub Actions: {} | CI: {} | step-debug: {}",
        env::is_github_actions(),
        env::is_ci(),
        log::is_debug()
    ));

    let ctx = actions_rs::Context::new();
    log::info(format!(
        "repo={:?} ref={:?} sha={:?}",
        ctx.repository(),
        ctx.ref_name(),
        ctx.sha()
    ));

    // Located annotation with a line range — should print:
    // ::warning title=demo,file=src/lib.rs,line=10,endLine=12::heads up
    Annotation::new()
        .file("src/lib.rs")
        .line(10)
        .end_line(12)
        .title("demo")
        .warning("heads up: this span looks suspicious");

    // Escaping check: newline in data, colon/comma in a property.
    Annotation::new()
        .title("type: mismatch, really")
        .error("line one\nline two");

    let total = log::group("expensive step", || {
        log::info("...working...");
        2 + 2
    });
    log::info(format!("group returned {total}"));

    actions_rs::warning!("formatted macro: {} items left", 7);

    output::set_output("answer", 42).expect("set_output");
    match output::export_var("DEMO_FLAG", true) {
        Ok(()) => {}
        Err(actions_rs::Error::UnavailableFileCommand {
            var: "GITHUB_ENV", ..
        }) => {
            log::info("GITHUB_ENV unset; skipping export_var in local demo");
        }
        Err(err) => panic!("export_var: {err}"),
    }

    let mut summary = Summary::new();
    summary
        .heading("Demo Report", 2)
        .raw("Built by the `demo` example.", true)
        .table([
            vec![Cell::header("Check"), Cell::header("Result")],
            vec![Cell::new("clippy"), Cell::new("pass")],
            vec![Cell::new("tests"), Cell::new("36 pass")],
        ])
        .code_block("cargo test", Some("sh"));
    summary.write().expect("write summary");
    log::info("summary written (if GITHUB_STEP_SUMMARY was set)");
}

pub fn colspan(self, n: u32) -> Self

Set the column span (clamped to ≥ 1; the HTML spec forbids 0).

Examples

use actions_rs::{Cell, Summary};
let mut s = Summary::new();
s.table([vec![Cell::new("wide").colspan(0)]]); // 0 clamps to 1
assert!(s.stringify().contains(r#"colspan="1""#));

pub fn rowspan(self, n: u32) -> Self

Set the row span (clamped to ≥ 1; the HTML spec forbids 0).

Examples

use actions_rs::{Cell, Summary};
let mut s = Summary::new();
s.table([vec![Cell::new("tall").rowspan(3)]]);
assert!(s.stringify().contains(r#"rowspan="3""#));

Trait Implementations

impl Clone for Cell

fn clone(&self) -> Cell

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cell

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

Formats the value using the given formatter.

impl From<&str> for Cell

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Cell

fn from(s: 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.