[][src]Enum jupyter_client::commands::Command

pub enum Command {
    KernelInfo,
    Execute {
        code: String,
        silent: bool,
        store_history: bool,
        user_expressions: HashMap<String, String>,
        allow_stdin: bool,
        stop_on_error: bool,
    },
    Inspect {
        code: String,
        cursor_pos: u64,
        detail_level: DetailLevel,
    },
    Complete {
        code: String,
        cursor_pos: u64,
    },
    History {
        output: bool,
        raw: bool,
        hist_access_type: HistoryAccessType,
        unique: bool,
    },
    IsComplete {
        code: String,
    },
    Shutdown {
        restart: bool,
    },
    CommInfo {
        target_name: Option<String>,
    },
}

Available commands.

Variants

Ask for information about the running kernel

Execute a specific command

Fields of Execute

Source code to be executed by the kernel, one or more lines.

A boolean flag which, if true, signals the kernel to execute this code as quietly as possible. silent=true forces store_history to be false, and will not:

  • broadcast output on the IOPub channel
  • have an execute_result The default is false.

A boolean flag which, if true, signals the kernel to populate history The default is true if silent is false. If silent is true, store_history is forced to be false.

A HashMap mapping names to expressions to be evaluated in the user's HashMap. The rich display-data representation of each will be evaluated after execution. See the display_data content for the structure of the representation data.

Some frontends do not support stdin requests. If this is true, code running in the kernel can prompt the user for input with an input_request message. If it is false, the kernel should not send these messages.

A boolean flag, which, if true, does not abort the execution queue, if an exception

  • is encountered. This allows the queued execution of multiple execute_requests, even if they generate exceptions.

Perform introspection into a piece of code.

Fields of Inspect

The code context in which introspection is requested this may be up to an entire multiline cell.

The cursor position within 'code' (in unicode characters) where inspection is requested

The level of detail desired. In IPython, the default (0) is equivalent to typing 'x?' at the prompt, 1 is equivalent to 'x??'. The difference is up to kernels, but in IPython level 1 includes the source code if available.

Ask the kernel to complete the code at the cursor.

Fields of Complete

The code context in which completion is requested this may be up to an entire multiline cell, such as 'foo = a.isal'

The cursor position within 'code' (in unicode characters) where completion is requested

Fetch history from the kernel.

Fields of History

If True, also return output history in the resulting dict.

If True, return the raw input history, else the transformed input.

So far, this can be range, tail or search. If hist_access_type is range, get a range of input cells. session is a number counting up each time the kernel starts; you can give a positive session number, or a negative number to count back from the current session. start and stop are line (cell) numbers within that session. If hist_access_type is 'tail' or 'search', get the last n cells. If hist_access_type is 'search', get cells matching the specified glob pattern (with * and ? as wildcards).

If hist_access_type is 'search' and unique is true, do not include duplicated history. Default is false.

Ask the kernel if the current code is complete

Fields of IsComplete

The code entered so far as a multiline string

Tell the kernel to shutdown.

Fields of Shutdown

False if final shutdown, or True if shutdown precedes a restart

Fetch comm info.

Fields of CommInfo

The target name

Trait Implementations

impl Debug for Command
[src]

impl Serialize for Command
[src]

Auto Trait Implementations

impl Send for Command

impl Sync for Command

Blanket Implementations

impl<T> From for T
[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same for T

Should always be Self