Enum IpyEscapeKind

Source

pub enum IpyEscapeKind {
    Shell,
    ShCap,
    Help,
    Help2,
    Magic,
    Magic2,
    Quote,
    Quote2,
    Paren,
}

Expand description

The kind of escape command as defined in IPython Syntax in the IPython codebase.

Variants§

§

Shell

Send line to underlying system shell (!).

§

ShCap

Send line to system shell and capture output (!!).

§

Help

Show help on object (?).

§

Help2

Show help on object, with extra verbosity (??).

§

Magic

Call magic function (%).

§

Magic2

Call cell magic function (%%).

§

Quote

Call first argument with rest of line as arguments after splitting on whitespace and quote each as string (,).

§

Quote2

Call first argument with rest of line as an argument quoted as a single string (;).

§

Paren

Call first argument with rest of line as arguments (/).

Implementations§

Source §

impl IpyEscapeKind

Source

pub const fn is_help(self) -> bool

Returns true if the escape kind is help i.e., ? or ??.

Source

pub const fn is_magic(self) -> bool

Returns true if the escape kind is magic i.e., % or %%.

Source

pub fn as_str(self) -> &'static str

Trait Implementations§

Source §

impl Clone for IpyEscapeKind

Source §

fn clone(&self) -> IpyEscapeKind

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for IpyEscapeKind

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for IpyEscapeKind

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Hash for IpyEscapeKind

Source §

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

Source §

impl PartialEq for IpyEscapeKind

Source §

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

Source §

impl TryFrom<[char; 2]> for IpyEscapeKind

Source §

type Error = String

The type returned in the event of a conversion error.

Source §

fn try_from(ch: [char; 2]) -> Result<Self, Self::Error>

Performs the conversion.

Source §

impl TryFrom<char> for IpyEscapeKind

Source §

type Error = String

The type returned in the event of a conversion error.

Source §

fn try_from(ch: char) -> Result<Self, Self::Error>

Performs the conversion.

Source §

impl Copy for IpyEscapeKind

Source §

impl Eq for IpyEscapeKind

Source §

impl StructuralPartialEq for IpyEscapeKind

Auto Trait Implementations§

§

impl UnwindSafe for IpyEscapeKind

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<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> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §