Struct druid::Selector

pub struct Selector<T = ()>(_, _);

An identifier for a particular command.

This should be a unique string identifier. Having multiple selectors with the same identifier but different payload types is not allowed and can cause Command::get and get_unchecked to panic.

The type parameter T specifies the command’s payload type. See Command for more information.

Certain Selectors are defined by Druid, and have special meaning to the framework; these are listed in the druid::commands module.

Implementations

impl Selector<()>

pub const NOOP: Selector = _

A selector that does nothing.

pub fn to(self, target: impl Into<Target>) -> Command

Turns this into a command with the specified Target.

impl<T> Selector<T>

pub const fn new(s: &'static str) -> Selector<T>

Create a new Selector with the given string.

impl<T: Any> Selector<T>

pub fn with(self, payload: T) -> Command

Convenience method for Command::new with this selector.

If the payload is () there is no need to call this, as Selector<()> implements Into<Command>.

By default, the command will have Target::Auto. The Selector::to method can be used to override this.

Trait Implementations

impl<T> Clone for Selector<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Selector<T>

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

Formats the value using the given formatter.

impl<T> Display for Selector<T>

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

Formats the value using the given formatter.

impl From<Selector<()>> for Command

fn from(selector: Selector) -> Command

Converts to this type from the input type.

impl<T: PartialEq> PartialEq<Selector<T>> for Selector<T>

fn eq(&self, other: &Selector<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for Selector<T>

impl<T: Eq> Eq for Selector<T>

impl<T> StructuralEq for Selector<T>

impl<T> StructuralPartialEq for Selector<T>