pub struct CommandSearchItem { /* private fields */ }Expand description
One application-owned command-search item.
IDs must be stable and unique inside a snapshot. Labels may be duplicated:
selection and emitted events always use id.
Implementations§
Source§impl CommandSearchItem
impl CommandSearchItem
Sourcepub fn new(id: impl Into<SharedString>, title: impl Into<SharedString>) -> Self
pub fn new(id: impl Into<SharedString>, title: impl Into<SharedString>) -> Self
Create an enabled item with stable identity and a visible title.
Sourcepub fn subtitle(self, subtitle: impl Into<SharedString>) -> Self
pub fn subtitle(self, subtitle: impl Into<SharedString>) -> Self
Set secondary descriptive text, which also participates in filtering.
Sourcepub fn keywords<I, S>(self, keywords: I) -> Selfwhere
I: IntoIterator<Item = S>,
S: Into<SharedString>,
pub fn keywords<I, S>(self, keywords: I) -> Selfwhere
I: IntoIterator<Item = S>,
S: Into<SharedString>,
Replace the extra case-insensitive search terms.
Sourcepub fn shortcut(self, shortcut: impl Into<SharedString>) -> Self
pub fn shortcut(self, shortcut: impl Into<SharedString>) -> Self
Set the visible shortcut hint.
Sourcepub fn disabled(self, disabled: bool) -> Self
pub fn disabled(self, disabled: bool) -> Self
Set whether the item is visible but unavailable to every activation path.
Sourcepub fn subtitle_text(&self) -> Option<&SharedString>
pub fn subtitle_text(&self) -> Option<&SharedString>
Return the optional secondary description.
Sourcepub fn keyword_terms(&self) -> &[SharedString]
pub fn keyword_terms(&self) -> &[SharedString]
Return the extra search terms.
Sourcepub fn shortcut_text(&self) -> Option<&SharedString>
pub fn shortcut_text(&self) -> Option<&SharedString>
Return the optional shortcut hint.
Sourcepub fn is_disabled(&self) -> bool
pub fn is_disabled(&self) -> bool
Return whether activation is disabled.
Trait Implementations§
Source§impl Clone for CommandSearchItem
impl Clone for CommandSearchItem
Source§fn clone(&self) -> CommandSearchItem
fn clone(&self) -> CommandSearchItem
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CommandSearchItem
impl Debug for CommandSearchItem
impl Eq for CommandSearchItem
Source§impl PartialEq for CommandSearchItem
impl PartialEq for CommandSearchItem
impl StructuralPartialEq for CommandSearchItem
Auto Trait Implementations§
impl Freeze for CommandSearchItem
impl RefUnwindSafe for CommandSearchItem
impl Send for CommandSearchItem
impl Sync for CommandSearchItem
impl Unpin for CommandSearchItem
impl UnsafeUnpin for CommandSearchItem
impl UnwindSafe for CommandSearchItem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key.
§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Instruments this type with the provided [
Span], returning an
Instrumented wrapper.§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘwhere
S: Into<Dispatch>,
Attaches the provided
Subscriber to this type, returning a
[WithDispatch] wrapper.