Struct StudyEditor 

pub struct StudyEditor { /* private fields */ }

The study editor panel.

Implementations

impl StudyEditor

pub fn new() -> Self

An empty, untitled document.

pub fn open_document( &mut self, title: impl Into<String>, text: impl Into<String>, )

Replaces the document, clearing diagnostics and status and the modified state.

pub fn title(&self) -> &str

The document title.

pub fn text(&self) -> &str

The document text, with the user’s edits.

pub fn is_modified(&self) -> bool

Whether the text differs from the text last opened or saved.

pub fn mark_saved(&mut self, text: &str)

Records that the host stored text, which clears the modified state if the user has not edited the document since the save request.

pub fn set_diagnostics(&mut self, diagnostics: Vec<Diagnostic>)

Replaces the diagnostics shown, most serious first as the host sends them.

pub fn diagnostics(&self) -> &[Diagnostic]

The diagnostics shown.

pub fn apply_result(&mut self, result: Result<(), String>)

Records the host’s answer to StudyEditorAction::Apply: Ok shows the text as applied, Err shows the reason. Neither changes the text.

pub fn reveal(&mut self, span: Range<usize>)

Selects the byte span in the text and scrolls to it in the next frame.

pub fn show(&mut self, ui: &mut Ui) -> StudyEditorAction

Shows the panel in ui and returns what the user asked of the host.

Trait Implementations

impl Default for StudyEditor

fn default() -> StudyEditor

Returns the “default value” for a type.