Struct Interest 

pub struct Interest { /* private fields */ }

Which of the plugin’s UI surfaces some viewer on the account shows now: the union over every viewer, kept by the account and pushed to the daemon half whenever it changes (a surface shown or hidden, a viewer that opens or goes away). A daemon half that reads an outside source only for its UI reads it while Interest::any holds and stops when it goes away: nothing on screen, nothing read. Instances count as their surface (workers@<machine> is workers).

Until the host has said anything (a host or account service without the signal) the interest is unknown, and Interest::any and Interest::shows answer true, so a plugin keeps working there.

Implementations

impl Interest

pub fn of<I, S>(surfaces: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Interest in exactly surfaces.

pub fn is_known(&self) -> bool

Whether the host has said anything yet.

pub fn any(&self) -> bool

Whether some viewer shows any surface of the plugin (or the interest is unknown).

pub fn shows(&self, surface: &str) -> bool

Whether some viewer shows surface (or the interest is unknown).

pub fn surfaces(&self) -> impl Iterator<Item = &str>

The surfaces shown, when known.

Trait Implementations

impl Clone for Interest

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Interest

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

Formats the value using the given formatter.

impl Default for Interest

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Interest

impl PartialEq for Interest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Interest