SpanTrait

Fully qualified path: core::array::SpanTrait

pub trait SpanTrait<T>

Trait functions

pop_front

Pops a value from the front of the span. Returns Option::Some(@value) if the array is not empty, Option::None otherwise. # Examples

let mut span = array![1, 2, 3].span();
assert!(span.pop_front() == Option::Some(@1));

Fully qualified path: core::array::SpanTrait::pop_front

fn pop_front(ref self: Span<T>) -> Option<@T>

pop_back

Pops a value from the back of the span. Returns Option::Some(@value) if the array is not empty, Option::None otherwise. # Examples

let mut span = array![1, 2, 3].span();
assert!(span.pop_back() == Option::Some(@3));

Fully qualified path: core::array::SpanTrait::pop_back

fn pop_back(ref self: Span<T>) -> Option<@T>

Pops multiple values from the front of the span. Returns an option containing a snapshot of a box that contains the values as a fixed-size array if the action completed successfully, 'Option::None' otherwise. # Examples

let mut span = array![1, 2, 3].span();
let result = *(span.multi_pop_front::<2>().unwrap());
let unboxed_result = result.unbox();
assert!(unboxed_result == [1, 2]);

Fully qualified path: core::array::SpanTrait::multi_pop_front

fn multi_pop_front<const SIZE: usize>(ref self: Span<T>) -> Option<@Box<[T; SIZE]>>

multi_pop_back

Pops multiple values from the back of the span. Returns an option containing a snapshot of a box that contains the values as a fixed-size array if the action completed successfully, 'Option::None' otherwise. # Examples

let mut span = array![1, 2, 3].span();
let result = *(span.multi_pop_back::<2>().unwrap());
let unboxed_result = result.unbox();
assert!(unboxed_result == [2, 3]);;

Fully qualified path: core::array::SpanTrait::multi_pop_back

fn multi_pop_back<const SIZE: usize>(ref self: Span<T>) -> Option<@Box<[T; SIZE]>>

get

Returns an option containing a box of a snapshot of the element at the given 'index' if the span contains this index, 'Option::None' otherwise. Element at index 0 is the front of the array. # Examples

let span = array![2, 3, 4];
assert!(span.get(1).unwrap().unbox() == @3);

Fully qualified path: core::array::SpanTrait::get

fn get(self: Span<T>, index: usize) -> Option<Box<@T>>

at

Returns a snapshot of the element at the given index. Element at index 0 is the front of the array. # Panics Panics if the index is out of bounds. # Examples

let span = array![2, 3, 4].span();
assert!(span.at(1) == @3);

Fully qualified path: core::array::SpanTrait::at

fn at(self: Span<T>, index: usize) -> @T

slice

Returns a span containing values from the 'start' index, with amount equal to 'length'. # Examples

let span = array![1, 2, 3].span();
assert!(span.slice(1, 2) == array![2, 3].span());

Fully qualified path: core::array::SpanTrait::slice

fn slice(self: Span<T>, start: usize, length: usize) -> Span<T>

len

Returns the length of the span as a usize value. # Examples

let span = array![2, 3, 4].span();
assert!(span.len() == 3);

Fully qualified path: core::array::SpanTrait::len

fn len(self: Span<T>) -> usize

is_empty

Returns whether the span is empty or not. # Examples

let span: Span<felt252> = array![].span();
assert!(span.is_empty());
let span = array![1, 2, 3].span();
assert!(!span.is_empty());

Fully qualified path: core::array::SpanTrait::is_empty

fn is_empty(self: Span<T>) -> bool

core - Cairo