Struct Claims 

pub struct Claims;

Implementations

impl Claims

pub fn claim(&self, key: &str, ttl_ms: u32) -> Result<bool>

Claims key for ttl_ms: true when this plugin session holds it (renewed if it already did); another viewer, even on this machine, or another daemon of a fleet plugin gets false; the claim expires after ttl_ms unless renewed. Both worlds.

pub fn release(&self, key: &str) -> Result<()>

pub fn once( &self, key: &str, ttl_ms: u32, effect: impl FnOnce(), ) -> Result<bool>

Runs effect only in the instance that wins the claim on key. Returns whether it ran.

Examples found in repository

examples/together_ui.rs (lines 104-106)

    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);
                });
            }
            _ => {}
        }
    }

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Claims

impl Debug for Claims

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

Formats the value using the given formatter.

impl Default for Claims

fn default() -> Self

Returns the “default value” for a type.