pub struct CardBuilder { /* private fields */ }Expand description
Fluent builder for fully custom Lark interactive cards.
Produces a GenericCardTemplate via CardBuilder::build.
§Example
use lark_webhook_notify::{CardBuilder, ColorTheme, TextAlign, TextSize};
let card = CardBuilder::new()
.header("Deploy Complete", Some("success"), Some(ColorTheme::Green), None)
.markdown("**Service:** api v1.4", TextAlign::Left, TextSize::Normal)
.columns()
.column("Env", Some("prod"), "auto", 1)
.column("Region", Some("us-east-1"), "weighted", 1)
.end_columns()
.collapsible("Logs", "Deploy OK", false)
.build();§Panics
build panics if columns was
called without a matching end_columns.
Implementations§
Source§impl CardBuilder
impl CardBuilder
pub fn new() -> Self
Sourcepub fn language(self, lang: LanguageCode) -> Self
pub fn language(self, lang: LanguageCode) -> Self
Override the language carried by this builder (default: Zh).
Sourcepub fn header(
self,
title: &str,
status: Option<&str>,
color: Option<ColorTheme>,
subtitle: Option<&str>,
) -> Self
pub fn header( self, title: &str, status: Option<&str>, color: Option<ColorTheme>, subtitle: Option<&str>, ) -> Self
Set the card header. Status auto-detects color if color is None: “running”|“submitted” → Wathet, “success”|“completed” → Green, “failed”|“error” → Red, “warning” → Orange, _ → Blue
Sourcepub fn metadata(self, label: &str, value: &str) -> Self
pub fn metadata(self, label: &str, value: &str) -> Self
Add a single **Label:** value metadata line as a markdown block.
Sourcepub fn metadata_block(self, fields: &[(&str, &str)]) -> Self
pub fn metadata_block(self, fields: &[(&str, &str)]) -> Self
Add multiple **Label:** value lines as a single markdown block.
Sourcepub fn markdown(
self,
content: &str,
text_align: TextAlign,
text_size: TextSize,
) -> Self
pub fn markdown( self, content: &str, text_align: TextAlign, text_size: TextSize, ) -> Self
Add a markdown text block with explicit alignment and size.
Sourcepub fn columns(self) -> Self
pub fn columns(self) -> Self
Begin a column group. Must be closed with end_columns.
Sourcepub fn column(
self,
label: &str,
value: Option<&str>,
width: &str,
weight: u32,
) -> Self
pub fn column( self, label: &str, value: Option<&str>, width: &str, weight: u32, ) -> Self
Add a column to the current column group.
width: "auto" for content-sized or "weighted" for proportional.
weight is only used when width = "weighted".
Sourcepub fn end_columns(self) -> Self
pub fn end_columns(self) -> Self
Close the current column group and add a column_set block to the card body.
Sourcepub fn collapsible(self, title: &str, content: &str, expanded: bool) -> Self
pub fn collapsible(self, title: &str, content: &str, expanded: bool) -> Self
Add a collapsible panel with a markdown body.
expanded = true renders the panel open by default.
Sourcepub fn add_block(self, block: impl Into<Value>) -> Self
pub fn add_block(self, block: impl Into<Value>) -> Self
Add any block that implements Into<serde_json::Value> directly.
Use this to insert raw block structs from the blocks module
or hand-crafted JSON values.
Sourcepub fn build(self) -> GenericCardTemplate
pub fn build(self) -> GenericCardTemplate
Finalize and return the card as a GenericCardTemplate.
§Panics
Panics if any column group opened with columns
was not closed with end_columns.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for CardBuilder
impl RefUnwindSafe for CardBuilder
impl Send for CardBuilder
impl Sync for CardBuilder
impl Unpin for CardBuilder
impl UnsafeUnpin for CardBuilder
impl UnwindSafe for CardBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);