Struct StmtIpyEscapeCommand 

pub struct StmtIpyEscapeCommand {
    pub node_index: AtomicNodeIndex,
    pub range: TextRange,
    pub kind: IpyEscapeKind,
    pub value: Box<str>,
}

An AST node used to represent a IPython escape command at the statement level.

For example,

%matplotlib inline

Terminology

Escape commands are special IPython syntax which starts with a token to identify the escape kind followed by the command value itself. Escape kind are the kind of escape commands that are recognized by the token: %, %%, !, !!, ?, ??, /, ;, and ,.

Help command (or Dynamic Object Introspection as it’s called) are the escape commands of the kind ? and ??. For example, ?str.replace. Help end command are a subset of Help command where the token can be at the end of the line i.e., after the value. For example, str.replace?.

Here’s where things get tricky. I’ll divide the help end command into two types for better understanding:

1. Strict version: The token is only at the end of the line. For example, str.replace? or str.replace??.
2. Combined version: Along with the ? or ?? token, which are at the end of the line, there are other escape kind tokens that are present at the start as well. For example, %matplotlib? or %%timeit?.

Priority comes into picture for the “Combined version” mentioned above. How do we determine the escape kind if there are tokens on both side of the value, i.e., which token to choose? The Help end command always takes priority over any other token which means that if there is ?/?? at the end then that is used to determine the kind. For example, in %matplotlib? the escape kind is determined using the ? token instead of % token.

Syntax

<IpyEscapeKind><Command value>

The simplest form is an escape kind token followed by the command value. For example, %matplotlib inline, /foo, !pwd, etc.

<Command value><IpyEscapeKind ("?" or "??")>

The help end escape command would be the reverse of the above syntax. Here, the escape kind token can only be either ? or ?? and it is at the end of the line. For example, str.replace?, math.pi??, etc.

<IpyEscapeKind><Command value><EscapeKind ("?" or "??")>

The final syntax is the combined version of the above two. For example, %matplotlib?, %%timeit??, etc.

Fields

node_index: AtomicNodeIndex

range: TextRange

kind: IpyEscapeKind

value: Box<str>

Trait Implementations

impl Clone for StmtIpyEscapeCommand

fn clone(&self) -> StmtIpyEscapeCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StmtIpyEscapeCommand

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

Formats the value using the given formatter.

impl<'a> From<&'a StmtIpyEscapeCommand> for AnyNodeRef<'a>

fn from(node: &'a StmtIpyEscapeCommand) -> AnyNodeRef<'a>

Converts to this type from the input type.

impl<'a> From<&'a StmtIpyEscapeCommand> for StmtRef<'a>

fn from(node: &'a StmtIpyEscapeCommand) -> Self

Converts to this type from the input type.

impl From<StmtIpyEscapeCommand> for Stmt

fn from(node: StmtIpyEscapeCommand) -> Self

Converts to this type from the input type.

impl HasNodeIndex for StmtIpyEscapeCommand

fn node_index(&self) -> &AtomicNodeIndex

Returns the AtomicNodeIndex for this node.

impl PartialEq for StmtIpyEscapeCommand

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

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

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

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

impl Ranged for StmtIpyEscapeCommand

fn range(&self) -> TextRange

The range of this item in the source text.

fn start(&self) -> TextSize

The start offset of this item in the source text.

fn end(&self) -> TextSize

The end offset of this item in the source text.

impl<'a> TryFrom<AnyRootNodeRef<'a>> for &'a StmtIpyEscapeCommand

type Error = ()

The type returned in the event of a conversion error.

fn try_from(node: AnyRootNodeRef<'a>) -> Result<&'a StmtIpyEscapeCommand, ()>

Performs the conversion.

impl StructuralPartialEq for StmtIpyEscapeCommand