Struct Context 

pub struct Context { /* private fields */ }

What a plugin is called with besides a frame: its configuration, and handles to every interface.

Implementations

impl Context

pub const fn new() -> Self

pub fn config_json(&self) -> Json

The configuration document activate was called with.

pub fn config<T: DeserializeOwned>(&self) -> Result<T>

The configuration, deserialized (an empty document is null).

pub fn values(&self) -> Values

Examples found in repository

examples/together_ui.rs (line 45)

    fn reload(&mut self, cx: &Context) {
        // A missing value (the companion has not run yet) keeps the default.
        if let Ok(Some(status)) = cx.values().get::<Status>("together.status") {
            self.status = status;
        }
    }

pub fn live(&self) -> Live

pub fn events(&self) -> Events

Examples found in repository

examples/together_ui.rs (line 68)

    fn activate(cx: &mut Context) -> Self {
        let _ = cx.events().on("together.*");
        let mut plugin = Self {
            card: Surface::new("card"),
            status: Status::default(),
        };
        plugin.reload(cx);
        plugin
    }

pub fn calls(&self) -> Calls

Examples found in repository

examples/together_ui.rs (line 105)

    fn event(&mut self, event: Event, cx: &mut Context) {
        match event {
            Event::Plugin { name, .. } if name == "together.changed" => {
                self.reload(cx);
                self.paint();
                // A commit from an event is sampled on the next frame;
                // ask for one.
                cx.request_frame();
            }
            Event::Resize { .. } => {
                self.paint();
                cx.request_frame();
            }
            Event::Pointer(pointer) if pointer.kind == PointerKind::Down => {
                // Side-effect free unless this viewer is the one the user
                // is driving, and then exactly once across viewers.
                if !view::is_driving() {
                    return;
                }
                // `send` returns at once: the companion's answer arrives as
                // the value it writes, not here.
                let _ = claims().once("together.rebuild", 5_000, || {
                    let _ = cx.calls().send("rebuild", &(), Target::Singleton);
                });
            }
            _ => {}
        }
    }

pub fn claims(&self) -> Claims

pub fn is_driving(&self) -> bool

pub fn capabilities(&self) -> Capabilities

pub fn request_frame(&self)

Asks for a frame on the next paced frame, from an event handler (inside UiPlugin::frame, use Frame::request_frame). A commit in event is otherwise sampled on the next frame something else causes.

Examples found in repository

examples/together_ui.rs (line 90)

    fn event(&mut self, event: Event, cx: &mut Context) {
        match event {
            Event::Plugin { name, .. } if name == "together.changed" => {
                self.reload(cx);
                self.paint();
                // A commit from an event is sampled on the next frame;
                // ask for one.
                cx.request_frame();
            }
            Event::Resize { .. } => {
                self.paint();
                cx.request_frame();
            }
            Event::Pointer(pointer) if pointer.kind == PointerKind::Down => {
                // Side-effect free unless this viewer is the one the user
                // is driving, and then exactly once across viewers.
                if !view::is_driving() {
                    return;
                }
                // `send` returns at once: the companion's answer arrives as
                // the value it writes, not here.
                let _ = claims().once("together.rebuild", 5_000, || {
                    let _ = cx.calls().send("rebuild", &(), Target::Singleton);
                });
            }
            _ => {}
        }
    }

pub fn wake_at(&self, at_ms: u64)

Asks for a frame at at_ms on the viewer’s clock.

pub fn open(&self, surface: &str) -> Result<()>

Opens a stage surface. Only while handling a user gesture: a key, a paste, a pointer press on one of the plugin’s surfaces, or one of its commands.

pub fn focus_pane(&self, pane: &str) -> Result<()>

Shows a pane in this viewer’s workspace and gives it focus, as a click on its sidebar row does. Only while handling a user gesture, as Context::open; a pane the viewer does not know is ignored.

pub fn open_url(&self, url: &str) -> Result<()>

Opens an https:// URL in the user’s browser (crate::url::open): while handling user input, or within a second after it.

pub fn close(&self, surface: &str) -> Result<()>

Closes a surface Context::open opened.

pub fn request_size(&self, surface: &str, cols: u32, rows: u32) -> Result<()>

Asks for surface to be cols by rows cells (0: the viewer’s choice in that dimension) instead of the manifest’s size. The viewer clamps it where it places the surface and sends Event::Resize when the size changes. A card grows to show more rows; a popover fits its content.

pub fn set_label(&self, surface: &str, label: Option<&str>) -> Result<()>

Sets a short label the viewer shows at the right end of surface’s chrome title: a boxed card’s top border, a pane’s header, a column’s title row. None removes it. At most 48 characters with no control characters.

pub fn set_caret(&self, surface: &str, caret: Option<(u32, u32)>) -> Result<()>

Places the viewer’s own text cursor at (col, row) of surface while the surface takes keys (an open stage, popover or pane overlay, or the surface a click or open gave input focus), so a text field draws no cursor of its own; the cursor trail moves to it. None removes it. Stays until set again.

Trait Implementations

impl Debug for Context

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

Formats the value using the given formatter.

impl Default for Context

fn default() -> Self

Returns the “default value” for a type.