Enum rucline::prompt::Outcome

pub enum Outcome {
    Accepted(String),
    Canceled(Buffer),
}

The outcome of read_line, being either accepted or canceled by the user.

Variants

Accepted(String)

If the user accepts the prompt input, i.e. an Accept event was emitted. this variant will contain the accepted text.

Canceled(Buffer)

If the user cancels the prompt input, i.e. a Cancel event was emitted. this variant will contain the rejected buffer, with text and cursor position intact from the moment of rejection.

Implementations

impl Outcome

#[must_use]pub fn was_acceoted(&self) -> bool

Returns true if the outcome was accepted.

#[must_use]pub fn unwrap(self) -> String

Returns accepted text.

Panics

Panics if the Outcome is Canceled

#[must_use]pub fn some(self) -> Option<String>

Converts this Outcome into an optional containing the accepted text.

Return

• Some(String) - If the Outcome is accepted.
• None - If the Outcome is canceled.

pub fn ok(self) -> Result<String, Buffer>

Converts this Outcome into a result containing the accepted text or the canceled buffer.

Return

• Ok(String) - If the Outcome is accepted.
• Err(Buffer) - If the Outcome is canceled.

Errors

• Buffer - If the user canceled the input.