Function brane_cli::repl::start

source ·
pub async fn start(
    proxy_addr: Option<String>,
    remote: bool,
    attach: Option<AppId>,
    language: Language,
    clear: bool,
    profile: bool,
    docker_opts: DockerOptions,
    keep_containers: bool,
) -> Result<(), Error>
Expand description

Entrypoint to the REPL, which performs the required initialization.

§Arguments

  • proxy_addr: The address to proxy any data transfers through if they occur.
  • remote: Whether to use the remote Brane instance in the login file to run the on instead.
  • attach: If not None, defines the session ID of an existing session to connect to.
  • language: The language with which to compile the file.
  • clear: Whether or not to clear the history of the REPL before beginning.
  • profile: If given, prints the profile timings to stdout if available.
  • docker_opts: The DockerOpts that determines how we connect to the local Docker dameon.
  • keep_containers: Whether to keep containers after execution or not.

§Errors

This function errors if we could not properly read from/write to the terminal. Additionally, it may error if any of the given statements fails for whatever reason.