Struct MenuItem

pub struct MenuItem { /* private fields */ }

A data structure representing a line-item in a menu

The recommended way of constructing these is to use the menu_item! macro though the output will be the same

Example

let menu_item = MenuItem::new("A Menu Item".to_string())
    .visible_at_rest(true)
    .at_rest_position(1);

// is the same as

menu_item!("A Menu Item", true, 1);

Implementations

impl MenuItem

pub fn new(visible_name: String) -> Self

Create a new MenuItem with the visible name specified

pub fn visible_at_rest(self, visible: bool) -> Self

Set whether a MenuItem is visible when no search is showing

pub fn at_rest_position(self, position: usize) -> Self

Set a MenuItem’s resting position in the no search menu Note: Won’t have any effect if visible_at_rest is false

pub fn add_alternative_match(self, new_matches: Vec<String>) -> Self

Set alternative matches for a MenuItem. These are strings that this item will match to when searching - in addition to the visible_name

Trait Implementations

impl Clone for MenuItem

fn clone(&self) -> MenuItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MenuItem

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

Formats the value using the given formatter.

impl Hash for MenuItem

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MenuItem

fn cmp(&self, other: &MenuItem) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MenuItem

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for MenuItem

fn partial_cmp(&self, other: &MenuItem) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for MenuItem

impl StructuralPartialEq for MenuItem