Struct stack_array::Array[−][src]

pub struct Array<T, const N: usize> { /* fields omitted */ }

Expand description

A data structure for storing and manipulating fixed number of elements of a specific type.

Implementations

[src]

impl<T, const N: usize> Array<T, N>

[src]

pub const fn new() -> Self

Creates a new Array<T, N>.

Examples

use stack_array::Array;

let arr = Array::<u8, 4>::new();
// or
let arr: Array<u8, 4> = Array::new();

[src]

pub const fn capacity(&self) -> usize

Returns the number of elements the array can hold.

Examples

use stack_array::Array;

let arr: Array<u8, 4> = Array::new();
assert_eq!(arr.capacity(), 4);

[src]

pub const fn len(&self) -> usize

Returns the number of elements currently in the array.

Examples

use stack_array::Array;
     
let arr: Array<u8, 3> = Array::from([1, 2]);
assert_eq!(arr.len(), 2);

[src]

pub const fn is_full(&self) -> bool

Returns true, If the array is full.

Examples

use stack_array::Array;

let arr: Array<u8, 3> = Array::from([1, 2]);
assert!(!arr.is_full());

[src]

pub const fn is_empty(&self) -> bool

Returns true if the array contains no elements.

Examples

use stack_array::Array;

let mut arr: Array<u8, 2> = Array::new();
assert!(arr.is_empty());
 
arr.push(1);
assert!(!arr.is_empty());

[src]

pub const fn remaining_capacity(&self) -> usize

Returns the number of elements can be inserted into the array.

Examples

use stack_array::Array;

let arr: Array<u8, 3> = Array::from([1, 2]);
assert_eq!(arr.remaining_capacity(), 1);

[src]

pub fn push(&mut self, val: T)

Appends an element to the back of a collection

Examples

use stack_array::Array;

let mut arr: Array<u8, 3> = Array::from([1]);
arr.push(2);
arr.push(3);
assert_eq!(&arr[..], [1, 2, 3]);

Panics

Panics if the array is full.

[src]

pub fn pop(&mut self) -> T

Removes the last element from a collection and returns it.

Examples

use stack_array::Array;

let mut arr: Array<u8, 3> = Array::from([1, 2]);
assert_eq!(arr.pop(), 2);
assert_eq!(arr.pop(), 1);
assert!(arr.is_empty());

Panics

Panics if the array is empty.

[src]

pub fn clear(&mut self)

Clears the array, removing all values.

Examples

use stack_array::Array;

let mut list: Array<u8, 3> = Array::from([1, 2, 3]);
list.clear();
assert!(list.is_empty());

[src]

pub fn insert(&mut self, index: usize, val: T)

Inserts an element at position index within the array, shifting all elements after it to the right.

Examples

use stack_array::Array;

let mut list: Array<u8, 3> = Array::from([3]);
list.insert(0, 1);
assert_eq!(&list[..], [1, 3]);
list.insert(1, 2);
assert_eq!(&list[..], [1, 2, 3]);

Panics

Panics if the index is out of bounds.

[src]

pub fn remove(&mut self, index: usize) -> T

Removes an element from position index within the array, shifting all elements after it to the left.

Examples

use stack_array::Array;

let mut list: Array<u8, 3> = Array::from([1, 2, 3]);
assert_eq!(list.remove(0), 1);
assert_eq!(list.remove(0), 2);
assert_eq!(list.remove(0), 3);