Struct StudioOpening 

pub struct StudioOpening {
    pub path: String,
    pub mode: StudioMode,
    pub text: Option<&'static str>,
}

The file the Studio opens with, the mode it opens in, and its text when the site carries it.

Fields

path: String

The file’s VFS path, with its leading slash.

mode: StudioMode

The mode the file opens in.

text: Option<&'static str>

The file’s text when the site carries it, as it does every shipped example. A reader’s own file has none until the file system reads it.

Implementations

impl StudioOpening

pub fn for_route(file: Option<&str>) -> Self

What the Studio opens on for the route’s file, a VFS path with or without its leading slash: a shipped example in its own mode with its text; a reader’s file in the mode its path names, its text left to the file system; and with no file, the first example.

pub fn first_example() -> Self

A bare /studio: the first Code example, in the order the file browser shows the examples.

pub fn editor_text(&self, mode: StudioMode) -> String

The text mode’s editor starts with: the opening’s text in its own mode’s editor — Code and Web share one — and nothing in the others.

pub fn current_file(&self) -> Option<String>

The file the Studio shows open from its first frame: the opening’s, when the site carries its text. A reader’s own file is open only once the file system has read it.

pub fn arrival( &self, open: Option<&str>, editor: &str, read: Option<String>, ) -> Arrival

What the file system’s answer changes: open is the file open now, editor what the opening’s editor holds, and read the file’s text, None when the file system has no such file.

What the reader does is theirs: once they have opened another file, or the editor holds anything but what the Studio opened with, nothing replaces it. Otherwise a reader’s file opens with its text, an example whose stored copy differs opens with that copy, and a file nobody has falls back to the first example. An example already on screen stays as it is, stored or not.

Trait Implementations

impl Clone for StudioOpening

fn clone(&self) -> StudioOpening

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StudioOpening

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

Formats the value using the given formatter.

impl PartialEq for StudioOpening

fn eq(&self, other: &StudioOpening) -> 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 Eq for StudioOpening

impl StructuralPartialEq for StudioOpening