Struct libdof::Layer

pub struct Layer(/* private fields */);

An abstraction of Vec<Vec<Key>> to represent a layer on a layout.

Implementations

impl Layer

pub fn get_key(&self, pos: Pos) -> Result<&Key, DofError>

Gets a reference to a key from a particular layer given a row and a column.

pub fn get_key_mut(&mut self, pos: Pos) -> Result<&mut Key, DofError>

Gets a mutable reference to a key from a particular layer given a row and a column.

pub fn set_key(&mut self, pos: Pos, key: Key) -> Result<(), DofError>

Sets a key at a particular position.

Trait Implementations

impl Clone for Layer

fn clone(&self) -> Layer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Layer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Vec<Vec<Key>>> for Layer

fn from(f: Vec<Vec<Key>>) -> Self

Converts to this type from the input type.

impl Keyboard for Layer

type K = Key

A type representing a key.

fn inner(&self) -> &[Vec<Self::K>]

Get a reference to the inner rows of the keyboard.

fn into_inner(self) -> Vec<Vec<Self::K>>

Convert into underlying vectors of the keyboard.

fn rows(&self) -> impl Iterator<Item = &Vec<Self::K>>

Get an iterator over each row of the keyboard.

fn keys(&self) -> impl Iterator<Item = &Self::K>

Get an iterator over the individual keys of the keyboard.

fn shape(&self) -> Shape

Get the shape of the keyboard.

fn row_count(&self) -> usize

Get the amount of rows of the keyboard.

fn fits_in(&self, shape: &Shape) -> bool

For each row of the keyboard, checks whether or not it’s smaller or equal to the given shape’s row.

fn resized( &self, Anchor: Anchor, desired_shape: Shape, ) -> Result<Vec<Vec<Self::K>>, DofError>

Given a specific keyboard, an Anchor and the Shape, resize to the given shape. Returns an error if the shape is bigger than the provided keyboard.

impl PartialEq for Layer

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

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

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 Serialize for Layer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Layer

impl StructuralPartialEq for Layer