Struct cubing::alg::Alg

pub struct Alg {
    pub nodes: Vec<AlgNode>,
}

A representation of a cubing alg, the equivalent of https://js.cubing.net/cubing/api/classes/alg.Alg.html

To create a fresh alg, it is often useful to use parse_alg macro:

use cubing::alg::parse_alg;

let alg = parse_alg!("F U R");
assert_eq!(alg.invert(), parse_alg!("R' U' F'"));

Fields

nodes: Vec<AlgNode>

Implementations

impl Alg

pub fn invert(&self) -> Alg

Trait Implementations

impl Clone for Alg

fn clone(&self) -> Alg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Alg

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

Formats the value using the given formatter.

impl Default for Alg

fn default() -> Alg

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Alg

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Alg

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

Formats the value using the given formatter.

impl FromStr for Alg

type Err = AlgParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Alg, <Alg as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for Alg

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

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 TryFrom<&str> for Alg

type Error = AlgParseError

The type returned in the event of a conversion error.

fn try_from(input: &str) -> Result<Alg, <Alg as TryFrom<&str>>::Error>

Performs the conversion.

impl StructuralPartialEq for Alg