Struct Playground 

pub struct Playground { /* private fields */ }

A place to write code and see what it makes, for documentation, tutorials and tools.

The code is on one side and the result on the other; below 768 pixels they become two tabs. Run (or Ctrl/Cmd+Enter) hands the code to the Runner. When it has problems, they are listed under the editor and marked on their lines, and the last result that worked stays, labeled as such. Examples fill the editor, Restore puts the chosen example back, and the app can add buttons that receive the code, such as one that copies a link.

use ravenrs_widgets::{AnyView, CodeDiagnostic, Playground, Text, Ui};

let runner = |source: &str| -> Result<AnyView, Vec<CodeDiagnostic>> {
    match source.trim().strip_prefix("say ") {
        Some(words) => Ok(Box::new(Text::new(words.to_owned()))),
        None => Err(vec![CodeDiagnostic::error(1, 1, 3, "Start with `say`")]),
    }
};
let playground = Playground::new(runner).example("Hello", "say hello").height(400.0);
let mut ui = Ui::new(playground, ravenrs_style::Theme::raven_dark());
ui.update();

Implementations

impl Playground

pub fn new(runner: impl Runner + 'static) -> Playground

A playground whose code runner runs.

pub fn example( self, name: impl Into<String>, source: impl Into<String>, ) -> Playground

An example to start from, listed in the bar; the first one fills the editor.

pub fn source(self, source: Binding<String>) -> Playground

Keeps the code in source, so the app can save it, share it or start from it. While it is empty, or without it, the playground starts from the first example.

pub fn chosen_example(self, example: Binding<usize>) -> Playground

Keeps which example is chosen in example.

pub fn language(self, language: CodeLanguage) -> Playground

The language the editor colors; Rust by default.

pub fn title(self, title: impl Into<String>) -> Playground

A title at the start of the bar.

pub fn note(self, note: impl Into<String>) -> Playground

A line under the bar, such as what this playground can and cannot run yet.

pub fn action( self, label: impl Into<String>, icon: IconName, then: impl Fn(&str) + 'static, ) -> Playground

A button in the bar that gets the code as it is.

pub fn download( self, make: impl Fn(&str) -> Result<(String, Vec<u8>), Vec<CodeDiagnostic>> + 'static, ) -> Playground

A button that saves what make turns the code into, such as a project to build, with the system’s dialog on a desktop or as a download in a browser. make gives the file’s name and bytes, or the problems to mark in the code.

pub fn output_open(self, open: bool) -> Playground

Whether the output starts open (it does by default). Folded, the result keeps the room, as on a small page about one example; a problem opens it all the same.

pub fn height(self, height: f32) -> Playground

A fixed height; by default it takes the room its parent gives.

Trait Implementations

impl Debug for Playground

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

Formats the value using the given formatter.

impl View for Playground

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.