Struct Region

pub struct Region<'a, T>(/* private fields */);

A region of two separate slices that represent continuous data.

Ring implements a “ring-buffer”, meaning the left and right regions can overlap the ends of the underlying buffer, causing them to be split into two contiguous slices (chunks). Region represents these two chunks, allowing their data to be accessed mostly like one continuous slice without allocations or copies.

Implementations

impl<'a, T> Region<'a, T>

pub fn new(slice_0: &'a [T], slice_1: &'a [T]) -> Self

Creates a region with two slices.

The slices should represent continuous data, where slice_0 goes before slice_1.

pub fn is_empty(&self) -> bool

Returns true if the region has a length of 0.

pub fn len(&self) -> usize

Returns the number of elements in the region.

pub fn iter(&self) -> impl Iterator<Item = &'a T> + 'a

Returns an iterator over the region.

The iterator yields all items from start to end.

pub fn contiguous(&self) -> &'a [T]

Returns the first contiguous slice in the region.

The slice will not necessarily contain all data in the region. If the region is not empty, the slice is guaranteed to contain some data.

pub fn slice<R>(&self, range: R) -> Self

where R: RangeBounds<usize>,

Slices the region, returning a new region containing a part of the original.

Panics

Panics if the start or end of the range is >= region.len().

impl<'a, T> Region<'a, T>

where T: Copy,

pub fn copy_to_slice(&self, dest: &mut [T])

Copies all elements in the region into dest, using a memcpy.

The length of dest must be the same as self.

If T does not implement Copy, use clone_to_slice.

Panics

This function will panic if dest has a different length to self.

impl<'a, T> Region<'a, T>

where T: Clone,

pub fn clone_to_slice(&self, dest: &mut [T])

Copies all elements in the region into dest.

The length of dest must be the same as self.

Panics

This function will panic if dest has a different length to self.

Trait Implementations

impl<'a, T: Clone> Clone for Region<'a, T>

fn clone(&self) -> Region<'a, T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Region<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Default for Region<'a, T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: Hash> Hash for Region<'a, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> Index<usize> for Region<'a, T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, T: PartialEq> PartialEq for Region<'a, T>

fn eq(&self, other: &Region<'a, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: Copy> Copy for Region<'a, T>

impl<'a, T: Eq> Eq for Region<'a, T>

impl<'a, T> StructuralPartialEq for Region<'a, T>