Struct CopyLayout 

#[non_exhaustive]
pub struct CopyLayout<'a> {
    pub shape: &'a Shape,
    pub strides: &'a Strides,
    pub elem_size: usize,
    pub pitch: Option<Pitch>,
}

The layout of the device side of a copy.

The pitch is computed once, by of, because whether a buffer’s rows are padded is the same question whichever driver performs the copy — and getting it wrong scrambles the rows rather than failing.

Which is why a driver cannot build one. The fields are readable, since a driver needs all four, but only of puts them together: a hand-built layout could carry a pitch its strides do not agree with, and nothing downstream would notice.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

shape: &'a Shape

The extent of each dimension.

strides: &'a Strides

The stride of each dimension, in elements.

elem_size: usize

The size of one element, in bytes.

pitch: Option<Pitch>

The 2D geometry when the rows are padded; None when the whole buffer is one contiguous span and a linear copy is both correct and faster.

Implementations

impl<'a> CopyLayout<'a>

pub fn of( shape: &'a Shape, strides: &'a Strides, elem_size: usize, ) -> Result<Self, IoError>

The layout of a copy over this shape, refusing anything the drivers cannot express.

Errors

IoError::UnsupportedStrides for a layout that is not pitched row-major. A driver copies either one contiguous span or a stack of evenly-spaced rows; nothing else has a call to make.