moveslice

Crates.iomoveslice
lib.rsmoveslice
version2.0.1
sourcesrc
created_at2019-08-02 19:23:08.086395
updated_at2019-08-03 15:47:36.167231
descriptionA one-function crate to move chunks in a slice around.
homepage
repositoryhttps://github.com/Calmynt/moveslice
max_upload_size
id153857
size10,937
A (enbyss)

documentation

README

moveslice

moveslice moveslice

This crate contains functionality to move a slice within an array around. It only uses safe functions, and acts efficiently by using the split_at_mut and rotate_left/rotate_right functions.

This crate also has a focus on being no_std, to allow this functionality in all cases where it is required.

The main feature this crate provides is implementing moveslice functions for any and all slices/arrays. In effect, it implements it on any type that also implements the AsMut<[T]> trait. This includes slices and vectors.

Examples:

use moveslice::{Moveslice, Error};

let mut arr = [1,2,3,4,5,6,7,8,9];

// The following moves the slice 3..6 to index 1.
// In effect, it moves [4,5,6] over to where [2] is.
arr.moveslice(3..6, 1);
assert_eq!(arr, [1,4,5,6,2,3,7,8,9]);

// The following moves the slice 3..6 to index 6.
// In effect, it moves [6,2,3] over to where [7] is.
arr.moveslice(3..6, 6);
assert_eq!(arr, [1,4,5,7,8,9,6,2,3]);

// The following attempts to move the slice beyond boundaries.
// The index given is 7, which exists in the array, but the
// last element of the chunk will not fit (7 + 3 = 10 > 9).
// Therefore, the following should fail.
arr.moveslice(3..6, 7); // will panic

// Panicking on failure however can prove to be not ideal.
// If instead of panicking, you prefer a `Result`, use
// `try_moveslice`.
let res = arr.try_moveslice(3..6, 7);
assert!(res.is_err());

// Moveslice also comes with its own `Error` enum, with diagnostic
// information to help debugging. The line before would have triggered
// an OutOfBoundsMove error. The following line would trigger the
// InvalidBounds error.
let res = arr.try_moveslice(9..10, 7);
assert!(if let Err(Error::InvalidBounds{..}) = res {true} else {false});

// You could pass the destination as the same value as chunk.0.
// However this would mean nothing is moved.
// This doesn't panic, but it's a no-op.
arr.moveslice(0..3, 0);

License: MPL-2.0

Commit count: 18

cargo fmt