Struct term_transcript::svg::HandlebarsData
source · #[non_exhaustive]pub struct HandlebarsData<'r> {
pub creator: CreatorData,
pub options: &'r TemplateOptions,
pub interactions: Vec<SerializedInteraction<'r>>,
pub has_failures: bool,
}
Available on crate feature
svg
only.Expand description
Root data structure sent to the Handlebars template.
Examples
Here’s example of JSON serialization of this type:
let mut transcript = Transcript::new();
let input = UserInput::command("rainbow");
transcript.add_interaction(input, "Hello, \u{1b}[32mworld\u{1b}[0m!");
let template_options = TemplateOptions {
palette: NamedPalette::Dracula.into(),
font_family: "Consolas, Menlo, monospace".to_owned(),
..TemplateOptions::default()
};
let data = template_options.render_data(&transcript).unwrap();
let expected_json = serde_json::json!({
"creator": {
"name": "term-transcript",
"version": "0.4.0-beta.1",
"repo": "https://github.com/slowli/term-transcript",
},
"width": 720,
"palette": {
"colors": {
"black": "#282936",
"red": "#ea51b2",
"green": "#ebff87",
"yellow": "#00f769",
"blue": "#62d6e8",
"magenta": "#b45bcf",
"cyan": "#a1efe4",
"white": "#e9e9f4",
},
"intense_colors": {
"black": "#626483",
"red": "#b45bcf",
"green": "#3a3c4e",
"yellow": "#4d4f68",
"blue": "#62d6e8",
"magenta": "#f1f2f8",
"cyan": "#00f769",
"white": "#f7f7fb",
},
},
"font_family": "Consolas, Menlo, monospace",
"window_frame": false,
"wrap": {
"hard_break_at": 80,
},
"line_numbers": null,
"has_failures": false,
"interactions": [{
"input": {
"text": "rainbow",
"prompt": "$",
"hidden": false,
},
"output_html": "Hello, <span class=\"fg2\">world</span>!",
"failure": false,
"exit_status": null,
}]
});
assert_eq!(serde_json::to_value(data).unwrap(), expected_json);
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.creator: CreatorData
Information about the rendering software.
options: &'r TemplateOptions
Template options used for rendering. These options are flattened into the parent during serialization.
interactions: Vec<SerializedInteraction<'r>>
Recorded terminal interactions.
has_failures: bool
Has any of terminal interactions failed?
Trait Implementations§
source§impl<'r> Debug for HandlebarsData<'r>
impl<'r> Debug for HandlebarsData<'r>
Auto Trait Implementations§
impl<'r> RefUnwindSafe for HandlebarsData<'r>
impl<'r> Send for HandlebarsData<'r>
impl<'r> Sync for HandlebarsData<'r>
impl<'r> Unpin for HandlebarsData<'r>
impl<'r> UnwindSafe for HandlebarsData<'r>
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
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
fn into_any_rc(self: Rc<T, Global>) -> Rc<dyn Any, Global>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.