Struct Layout 

pub struct Layout { /* private fields */ }

A complete set of key bindings the player can pick: one entry of layouts in the keymap file, named by its id. The file decides which layouts there are; this is only the name, kept inline so a layout is Copy. Names are ASCII letters, digits and _, at most LAYOUT_NAME_MAX bytes (RightHanded).

Implementations

impl Layout

pub const fn named(name: &'static str) -> Layout

The layout named name, for a game’s constants. Fails to compile in a const (panics elsewhere) if name isn’t a valid name.

pub fn from_name(name: &str) -> Option<Layout>

The layout named name, if it is a valid name (saved settings, the keymap file). Whether a keymap has it is KeymapDef::has_layout’s question.

pub fn name(&self) -> &str

The name used in keymap files and saved settings.

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Layout

impl Debug for Layout

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Layout

fn deserialize<D>( deserializer: D, ) -> Result<Layout, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Layout

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

Formats the value using the given formatter.

impl Eq for Layout

impl Hash for Layout

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

where __H: Hasher,

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 Layout

fn cmp(&self, other: &Layout) -> 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 Layout

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Layout

fn partial_cmp(&self, other: &Layout) -> 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 Serialize for Layout

A layout’s binary form (a baked keymap, pack) is its name.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Layout