Skip to main content

PromptPiece

Enum PromptPiece 

Source
pub enum PromptPiece {
Show 23 variants AsciiCharacter(u32), Backslash, BellCharacter, CarriageReturn, CurrentCommandNumber, CurrentHistoryNumber, CurrentUser, CurrentWorkingDirectory { tilde_replaced: bool, basename: bool, }, Date(PromptDateFormat), DollarOrPound, EndNonPrintingSequence, EscapeCharacter, EscapedSequence(String), Hostname { only_up_to_first_dot: bool, }, Literal(String), Newline, NumberOfManagedJobs, ShellBaseName, ShellRelease, ShellVersion, StartNonPrintingSequence, TerminalDeviceBaseName, Time(PromptTimeFormat),
}
Expand description

A piece of a prompt string.

Variants§

§

AsciiCharacter(u32)

An ASCII character.

§

Backslash

A backslash character.

§

BellCharacter

The bell character.

§

CarriageReturn

A carriage return character.

§

CurrentCommandNumber

The current command number.

§

CurrentHistoryNumber

The current history number.

§

CurrentUser

The name of the current user.

§

CurrentWorkingDirectory

Path to the current working directory.

Fields

§tilde_replaced: bool

Whether or not to apply tilde-replacement before expanding.

§basename: bool

Whether or not to only expand to the basename of the directory.

§

Date(PromptDateFormat)

The current date, using the given format.

§

DollarOrPound

The dollar or pound character.

§

EndNonPrintingSequence

Special marker indicating the end of a non-printing sequence of characters.

§

EscapeCharacter

The escape character.

§

EscapedSequence(String)

An escaped sequence not otherwise recognized.

§

Hostname

The hostname of the system.

Fields

§only_up_to_first_dot: bool

Whether or not to include only up to the first dot of the name.

§

Literal(String)

A literal string.

§

Newline

A newline character.

§

NumberOfManagedJobs

The number of actively managed jobs.

§

ShellBaseName

The base name of the shell.

§

ShellRelease

The release of the shell.

§

ShellVersion

The version of the shell.

§

StartNonPrintingSequence

Special marker indicating the start of a non-printing sequence of characters.

§

TerminalDeviceBaseName

The base name of the terminal device.

§

Time(PromptTimeFormat)

The current time, using the given format.

Trait Implementations§

Source§

impl Clone for PromptPiece

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PromptPiece

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for PromptPiece

Available on crate features serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for PromptPiece

Available on crate features serde only.
Source§

impl PartialEq for PromptPiece

Available on crate features serde only.
Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for PromptPiece

Available on crate features serde only.
Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for PromptPiece

Available on crate features serde only.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more