Struct term_transcript::UserInput

pub struct UserInput { /* private fields */ }

User input during interaction with a terminal.

Implementations

impl UserInput

pub fn command(text: impl Into<String>) -> Self

Creates a command input.

pub fn repl(text: impl Into<String>) -> Self

Creates a standalone / starting REPL command input with the >>> prompt.

pub fn repl_continuation(text: impl Into<String>) -> Self

Creates a REPL command continuation input with the ... prompt.

pub fn prompt(&self) -> Option<&str>

Returns the prompt part of this input.

pub fn hide(self) -> Self

Marks this input as hidden (one that should not be displayed in the rendered transcript).

Trait Implementations

impl AsRef<str> for UserInput

Returns the command part of the input without the prompt.

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UserInput

fn clone(&self) -> UserInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserInput

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

Formats the value using the given formatter.

impl From<&str> for UserInput

Calls Self::command() on the provided string reference.

fn from(command: &str) -> Self

Converts to this type from the input type.

impl PartialEq<UserInput> for UserInput

fn eq(&self, other: &UserInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for UserInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for UserInput

impl StructuralEq for UserInput

impl StructuralPartialEq for UserInput