Struct InOutBuf 

pub struct InOutBuf<'inp, 'out, T> { /* private fields */ }

A buffer that is read from and written to, which may or may not alias.

Drivers receive one of these for every cipher operation, covering both the in-place case (one buffer, encrypted in place) and the separate-buffer case (plaintext in one buffer, ciphertext to another) with a single entry point.

Implementations

impl<'inp, 'out, T> InOutBuf<'inp, 'out, T>

pub fn new( in_buf: &'inp [T], out_buf: &'out mut [T], ) -> Result<Self, NotEqualError>

Create an in/out buffer from separate input and output slices of equal length.

pub unsafe fn from_raw(in_ptr: *const T, out_ptr: *mut T, len: usize) -> Self

Construct from raw pointers.

Safety

in_ptr must be valid for reads and out_ptr for writes of len elements for the respective lifetimes. They may be equal; otherwise the regions must not overlap.

pub fn get_in(&self) -> &[T]

The input side.

pub fn get_out(&mut self) -> &mut [T]

The output side.

pub fn is_in_place(&self) -> bool

Whether the input and output are the same buffer.

pub unsafe fn split(self) -> (&'inp [T], &'out mut [T])

Split into the input and output slices.

When the buffer is in place, the returned slices alias. This is not exposed as safe API for that reason; use get_in, get_out or into_out_with_copied_in.

Safety

The caller must not use both slices when is_in_place.

pub fn into_out_with_copied_in(self) -> &'out mut [T]

where T: Copy,

Return the output slice, after copying the input into it when they differ.

The natural entry point for drivers that only operate in place.

pub fn reborrow_range( &mut self, start: usize, end: usize, ) -> InOutBuf<'_, '_, T>

Reborrow a sub-range of the buffer.

pub fn into_raw(self) -> (*const T, *mut T)

Consume the buffer and return the raw pointers.

pub fn len(&self) -> usize

Length of the buffer.

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Trait Implementations

impl<'a, T> From<&'a mut [T]> for InOutBuf<'a, 'a, T>

fn from(buf: &'a mut [T]) -> Self

Converts to this type from the input type.