cubing / cubing.rs

cubing.rs

Features from cubing.js in Rust.

Structure

See https://docs.rs/cubing/latest/cubing/ for Rust docs.

A subset of the cubing.js API is implemented under:

• cubing::alg
• cubing::kpuzzle
• cubing::puzzles

Most applications will use str.parse::<Alg>(…) and KPuzzle as entry points into the API:

use cubing::{alg::parse_alg, puzzles::cube3x3x3_kpuzzle};

pub fn main() {
    let kpuzzle = cube3x3x3_kpuzzle();
    let default_pattern = kpuzzle.default_pattern();

    let input_alg = parse_alg!("R U R' F' U2 L' U' L F U2");

    let input_pattern = default_pattern
        .apply_alg(&input_alg)
        .expect("Input alg is not valid for puzzle.");
    println!(
        "The following alg {} the puzzle to its original pattern (including center orientation): {}",
        if default_pattern == input_pattern { "returns" } else { "does NOT return" },
        input_alg,
    )
}

Development

This repository contains a port of f2lfast that is useful for exercising functionality (although it's not yet at full speed):

cargo run --example f2lfast -- --scramble "U2 F2 U' L' U L D2 F D2 B' D2 B D2 L2 B L2 F"

Run tests using:

make test

cubing.rs's Issues

Add a crate feature to support passing in JSON instead of loading from file

For the WASM builds.

Declare forward-compatible dependency versions

https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html

Use exported error types

Right now, we use a variety of error types. We should consolidate them into a few, such as:

• For Alg: ParseError (for the move "2")
• For KPuzzle: UnknownMoveError (for the move "T" on 3x3x3)

Remove hashing functions from the packed structs.