Struct sensehat_screen::scroll::Scroll

pub struct Scroll(_);

A type representing a collection of PixelFrames that may be scrolled.

Implementations

impl Scroll

pub fn new(frames: &[PixelFrame]) -> Self

Creates a new scroll from a slice of PixelFrames.

Panics

The scroll needs at least 2 PixelFrames to be created.

pub fn frames(&self) -> &[PixelFrame]

Returns &[PixelFrame] with the pixel frames that constitute this scroll.

pub fn clips(&self) -> Vec<Clip>

Returns Vec<Clip> with the pixel frames clips that may be rendered.

pub fn reverse(&mut self)

Reverse the order of the inner pixel frames.

pub fn len(&self) -> usize

Return the number of pixel frames in the scroll.

pub fn is_empty(&self) -> bool

Returns true if the scroll has no pixel frames.

pub fn right_to_left(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the right to the left.

pub fn left_to_right(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the left to the right.

pub fn top_to_bottom(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the top to the bottom.

pub fn bottom_to_top(&self) -> FrameSequence

Returns a FrameSequence iterator that moves the frames from the bottom to the bottom.

Trait Implementations

impl Debug for Scroll

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

Formats the value using the given formatter.

impl Index<usize> for Scroll

type Output = PixelFrame

The returned type after indexing.

fn index(&self, index: usize) -> &PixelFrame

Performs the indexing (container[index]) operation.

impl PartialEq<Scroll> for Scroll

fn eq(&self, other: &Scroll) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Scroll) -> bool

This method tests for !=.

impl StructuralPartialEq for Scroll