Type Alias LineRef

pub type LineRef<'s> = LineSlice<&'s [u8]>;

An reference to a single line of pixels. May go across the whole image or just a tile section of it.

This line contains an immutable slice that all samples will be read from.

Aliased Type

struct LineRef<'s> {
    pub location: LineIndex,
    pub value: &'s [u8],
}

Fields

location: LineIndex

Where this line is located inside the image.

value: &'s [u8]

The raw bytes of the pixel line, either &[u8] or &mut [u8]. Must be re-interpreted as slice of f16, f32, or u32, according to the channel data type.

Implementations

impl LineRef<'_>

pub fn read_samples_into_slice<T: Data>(self, slice: &mut [T]) -> UnitResult

Read the samples (f16, f32, u32 values) from this line value reference. Use read_samples if there is not slice available.

pub fn read_samples<T: Data>(&self) -> impl Iterator<Item = Result<T>> + '_

Iterate over all samples in this line, from left to right. Use read_sample_into_slice if you already have a slice of samples.

Trait Implementations

impl<T: Clone> Clone for LineSlice<T>

fn clone(&self) -> LineSlice<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for LineSlice<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for LineSlice<T>

fn eq(&self, other: &LineSlice<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<T: Copy> Copy for LineSlice<T>

impl<T: Eq> Eq for LineSlice<T>

impl<T> StructuralPartialEq for LineSlice<T>