Struct term_transcript::Transcript

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

Transcript of a user interacting with the terminal.

Implementations

impl Transcript

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.

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 the 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).

impl Transcript<Parsed>

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().

impl<Out: TermOutput> Transcript<Out>

pub fn new() -> Self

Creates an empty transcript.

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

Returns interactions in this transcript.

impl Transcript

pub fn add_existing_interaction( &mut self, interaction: Interaction ) -> &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.

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

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

This is a shortcut for calling [Self::add_existing_interaction(_)].

Trait Implementations

impl<Out: Clone + TermOutput> Clone for Transcript<Out>

fn clone(&self) -> Transcript<Out>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Out: Debug + TermOutput> Debug for Transcript<Out>

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

Formats the value using the given formatter.

impl<Out: TermOutput> Default for Transcript<Out>

fn default() -> Self

Returns the “default value” for a type.