Struct term_transcript::Transcript

source · [−]

pub struct Transcript<Out: TermOutput = Captured> { /* private fields */ }

Expand description

Transcript of a user interacting with the terminal.

Implementations

source

impl Transcript

source

pub fn from_inputs<Cmd: SpawnShell>(
options: &mut ShellOptions<Cmd>,
inputs: impl IntoIterator<Item = UserInput>
) -> Result<Self>

Constructs a transcript from the sequence of given user inputs.

The inputs are executed in the shell specified in options. A single shell is shared among all commands.

Errors

Returns an error if spawning the shell or any operations with it fail (such as reading stdout / stderr, or writing commands to stdin), or if the shell exits before all commands are executed.

source

pub fn capture_output(
 &mut self,
 input: UserInput,
 command: &mut Command
) -> Result<&mut Self>

Captures stdout / stderr of the provided command and adds it to Self::interactions().

The command is spawned with closed stdin. This method blocks until the command exits. The method succeeds regardless of the exit status of the command.

Errors

Returns an error if spawning the command or any operations with it fail (such as reading stdout / stderr).

source

impl Transcript<Parsed>

source

pub fn from_svg<R: BufRead>(reader: R) -> Result<Self, ParseError>

Available on crate feature test only.

Parses a transcript from the provided reader, which should point to an SVG XML tree produced by Template::render() (possibly within a larger document).

Errors

Returns an error if the input cannot be parsed, usually because it was not produced by Template::render().

source

impl<Out: TermOutput> Transcript<Out>

source

pub fn new() -> Self

Creates an empty transcript.

source

pub fn interactions(&self) -> &[Interaction<Out>]

Returns interactions in this transcript.

source

impl Transcript

source

pub fn add_interaction(
 &mut self,
 input: UserInput,
 output: impl Into<String>
) -> &mut Self

Manually adds a new interaction to the end of this transcript.

This method allows capturing interactions that are difficult or impossible to capture using more high-level methods: Self::from_inputs() or Self::capture_output(). The resulting transcript will render just fine, but there could be issues with testing it.