Struct Slice

#[repr(C)]
pub struct Slice<T> { /* private fields */ }

A C compatible slice of type T

Implementations

impl<T> Slice<T>

pub const unsafe fn from_raw_parts(ptr: *mut T, len: usize) -> Slice<T>

pub const fn from_slice_mut(slice: &mut [T]) -> Slice<T>

pub const fn from_slice(slice: &[T]) -> Slice<T>

pub const fn len(&self) -> usize

pub const fn as_ptr(&self) -> *const T

pub const unsafe fn as_slice_mut_unchecked<'a>(&self) -> &'a mut [T]

Converts an FFI [RawSlice<T>] into a raw rust slice of type T

pub const unsafe fn as_slice_unchecked<'a>(&self) -> &'a [T]

pub unsafe fn try_as_slice_mut_custom<'a>( &self, validator: impl FnOnce(*const ()) -> bool, ) -> Result<&'a mut [T], InvalidSliceError>

Attempts to convert an FFI [RawSlice<T>] into a raw rust slice of type T, running the pointer into a custom validator function

returns Err(InvalidSliceError) if the slice doesn’t pass the rust slice requirements or returns Err(InvalidSliceError::Other) if the validator function returns false

pub unsafe fn try_as_slice_custom<'a>( &self, validator: impl Fn(*const ()) -> bool, ) -> Result<&'a [T], InvalidSliceError>

Attempts to convert an FFI [RawSlice<T>] into a raw rust slice of type T, running the pointer into a custom validator function

returns Err(InvalidSliceError) if the slice doesn’t pass the rust slice requirements or returns Err(InvalidSliceError::Other) if the validator function returns false

pub unsafe fn try_as_slice_mut<'a>( &self, ) -> Result<&'a mut [T], InvalidSliceError>

pub unsafe fn try_as_slice<'a>(&self) -> Result<&'a [T], InvalidSliceError>

impl<T> Slice<Slice<T>>

pub const unsafe fn from_slices_ptr_mut( slices: *mut [*mut [T]], ) -> Slice<Slice<T>>

Converts an FFI Slice of slices to a Rust slice of slices of type T *mut [*mut [T]].

Safety

The given slice will be unsafely reused, for now the data will be left unchanged in the current rust version because the layout of Slice is the same as &[T], However since the layout of slices isn’t guaranteed yet by rust, this function may change the given buffer in the future, or by some obscure optimizations.

this should be solved if this RFC got accepted

pub unsafe fn try_into_slices_ptr_mut( self, custom_validate: impl Fn(*const ()) -> bool, ) -> Result<*mut [*mut [T]], InvalidSliceError>

Attempts to convert an FFI Slice of Slices into a rust slice of slices *mut [*mut [T]]. given an FFI Slice of Slices

Safety

The given FFI slice will be unsafely reused, for now the data will be left unchanged in the current rust version because the layout of Slice is the same as &[T], However since the layout of slices isn’t guaranteed yet by rust, this function may change the given buffer in the future, or by some obscure optimizations.

this should be solved if this RFC got accepted

impl Slice<Str>

pub const unsafe fn from_str_slices_mut(slices: *mut [*mut str]) -> Slice<Str>

Converts a mutable slice of string slices [*mut str] into an FFI safe Slice of Strs.

Safety

The given slice will be unsafely reused, for now the data will be left unchanged in the current rust version because the layout of Str is the same as &str, However since the layout of slices isn’t guaranteed yet by rust, this function may change the given buffer in the future.

this should be solved if this RFC got accepted

pub unsafe fn try_into_str_slices_mut<'a>( self, custom_validate: impl Fn(*const ()) -> bool, ) -> Result<*mut [&'a str], InvalidStrError>

Attempts to convert an FFI Slice of Strs into a rust slice of str slices *mut [*mut str]. given an FFI Slice of Strs

Safety

The given FFI slice will be unsafely reused, for now the data will be left unchanged in the current rust version because the layout of Str is the same as &str, However since the layout of slices isn’t guaranteed yet by rust, this function may change the given buffer in the future, or by some obscure optimizations.

this should be solved if this RFC got accepted

Trait Implementations

impl<T> Clone for Slice<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Slice<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> NotZeroable for Slice<T>

fn is_zero(&self) -> bool

impl<T> Copy for Slice<T>

where T: Copy,