[−][src]Struct abi_stable::std_types::slices::RSlice
Ffi-safe equivalent of &'a [T]
As of the writing this documentation the abi stability of &[T]
is
not yet guaranteed.
Lifetime problems
Because RSlice dereferences into a slice,you can call slice method on it.
If you call a slice method that returns a borrow into the slice,
it will have the lifetime of the let slice:RSlice<'a,[T]>
variable instead of the 'a
lifetime that it's parameterized over.
To get a slice with the same lifetime as an RSlice,
one must use the RSlice::as_slice
method.
Example of what would not work:
use abi_stable::std_types::RSlice; fn into_slice<'a,T>(slic:RSlice<'a,T>)->&'a [T] { &*slic }
Example of what would work:
use abi_stable::std_types::RSlice; fn into_slice<'a,T>(slic:RSlice<'a,T>)->&'a [T] { slic.as_slice() }
Example
Defining an extern fn that returns a reference to the first element that compares equal to a parameter.
use abi_stable::{ std_types::RSlice, sabi_extern_fn, }; #[sabi_extern_fn] pub fn find_first_mut<'a,T>(slice_:RSlice<'a,T>,element:&T)->Option<&'a T> where T:std::cmp::PartialEq { slice_.iter() .position(|x| x==element ) .map(|i| &slice_.as_slice()[i] ) }
Methods
impl<'a, T: 'a> RSlice<'a, T>
[src]
pub const EMPTY: Self
[src]
An empty slice.
pub const unsafe fn from_raw_parts(ptr_: *const T, len: usize) -> Self
[src]
Constructs an RSlice<'a,T>
from a pointer to the first element,
and a length.
Safety
Callers must ensure that:
-
ptr_ points to valid memory,
-
ptr_ .. ptr+len
range is àccessible memory. -
ptr_ is aligned to
T
. -
the data ptr_ points to must be valid for the lifetime of this
RSlice<'a,T>
Examples
This function unsafely converts a &[T]
to an RSlice<T>
,
equivalent to doing RSlice::from_slice
.
use abi_stable::std_types::RSlice; fn convert<T>(slice_:&[T])->RSlice<'_,T>{ unsafe{ RSlice::from_raw_parts( slice_.as_ptr(), slice_.len() ) } }
impl<'a, T> RSlice<'a, T>
[src]
pub fn as_slice(&self) -> &'a [T]
[src]
Creates an &'a [T]
with access to all the elements of this slice.
Example
use abi_stable::std_types::RSlice; assert_eq!(RSlice::from_slice(&[0,1,2,3]).as_slice(), &[0,1,2,3]);
pub const fn as_ptr(&self) -> *const T
[src]
Gets a raw pointer to the start of the slice.
pub const fn len(&self) -> usize
[src]
The length (in elements) of this slice.
Example
use abi_stable::std_types::RSlice; assert_eq!(RSlice::<u8>::from_slice(&[]).len(), 0); assert_eq!(RSlice::from_slice(&[0]).len(), 1); assert_eq!(RSlice::from_slice(&[0,1]).len(), 2);
pub const fn is_empty(&self) -> bool
[src]
Whether this slice is empty.
Example
use abi_stable::std_types::RSlice; assert_eq!(RSlice::<u8>::from_slice(&[]).is_empty(), true); assert_eq!(RSlice::from_slice(&[0]).is_empty(), false); assert_eq!(RSlice::from_slice(&[0,1]).is_empty(), false);
impl<'a, T> RSlice<'a, T>
[src]
pub const fn empty() -> Self
[src]
Creates an empty slice
pub const fn from_ref(ref_: &'a T) -> Self
[src]
Converts a reference to T
to a single element RSlice<'a,T>
.
Note:this function does not copy anything.
Example
use abi_stable::std_types::RSlice; assert_eq!(RSlice::from_ref(&0), RSlice::from_slice(&[0]) ); assert_eq!(RSlice::from_ref(&1), RSlice::from_slice(&[1]) ); assert_eq!(RSlice::from_ref(&2), RSlice::from_slice(&[2]) );
pub fn from_slice(slic: &'a [T]) -> Self
[src]
Converts a &[T]
to an RSlice<'_,T>
.
Constness
This function is a const fn
from Rust 1.39 onwards due to
the stabilization of <[T]>::len
.
Before Rust 1.39 the only safe way to construct an RSlice
constant is using the rslice
macro.
Example
use abi_stable::std_types::RSlice; let empty:&[u8]=&[]; assert_eq!(RSlice::<u8>::from_slice(&[]).as_slice(), empty); assert_eq!(RSlice::from_slice(&[0]).as_slice() , &[0][..]); assert_eq!(RSlice::from_slice(&[0,1]).as_slice() , &[0,1][..]);
pub fn slice<I>(&self, i: I) -> RSlice<'a, T> where
[T]: Index<I, Output = [T]>,
[src]
[T]: Index<I, Output = [T]>,
Creates an RSlice<'a,T>
with access to the range
range of elements.
This is an inherent method instead of an implementation of the ::std::ops::Index trait because it does not return a reference.
Example
use abi_stable::std_types::RSlice; let slic=RSlice::from_slice(&[0,1,2,3]); assert_eq!(slic.slice(..),RSlice::from_slice(&[0,1,2,3])); assert_eq!(slic.slice(..2),RSlice::from_slice(&[0,1])); assert_eq!(slic.slice(2..),RSlice::from_slice(&[2,3])); assert_eq!(slic.slice(1..3),RSlice::from_slice(&[1,2]));
pub fn to_rvec(&self) -> RVec<T> where
T: Clone,
[src]
T: Clone,
Creates a new RVec<T>
and clones all the elements of this slice into it.
Example
use abi_stable::std_types::{RSlice,RVec}; let slic=RSlice::from_slice(&[0,1,2,3]); assert_eq!( slic.slice(..).to_rvec(), RVec::from_slice(&[0,1,2,3]) ); assert_eq!( slic.slice(..2).to_rvec(), RVec::from_slice(&[0,1]) ); assert_eq!( slic.slice(2..).to_rvec(), RVec::from_slice(&[2,3]) ); assert_eq!( slic.slice(1..3).to_rvec(), RVec::from_slice(&[1,2]) );
pub const unsafe fn transmute_ref<U>(self) -> RSlice<'a, U> where
U: 'a,
[src]
U: 'a,
Transmutes n RSlice<'a,T>
to a RSlice<'a,U>
Trait Implementations
impl<'a, T> IntoReprRust for RSlice<'a, T>
[src]
impl<'a, T> GetStaticEquivalent_ for RSlice<'a, T> where
T: __StableAbi,
T: 'a,
[src]
T: __StableAbi,
T: 'a,
type StaticEquivalent = _static_RSlice<'static, __GetStaticEquivalent<T>>
impl<'a, T> SharedStableAbi for RSlice<'a, T> where
T: __StableAbi,
T: 'a,
[src]
T: __StableAbi,
T: 'a,
type IsNonZeroType = False
Whether this type has a single invalid bit-pattern. Read more
type Kind = __ValueKind
The kind of abi stability of this type,there are 2: Read more
const S_LAYOUT: &'static TypeLayout
[src]
const S_ABI_CONSTS: AbiConsts
[src]
impl<'a, T> Send for RSlice<'a, T> where
&'a [T]: Send,
[src]
&'a [T]: Send,
impl<'a, T> Sync for RSlice<'a, T> where
&'a [T]: Sync,
[src]
&'a [T]: Sync,
impl<'a, T: 'a> AsRef<[T]> for RSlice<'a, T>
[src]
impl<'a, T> Into<&'a [T]> for RSlice<'a, T>
[src]
impl<'a, T> From<RSlice<'a, T>> for RCow<'a, [T]> where
T: Clone,
[src]
T: Clone,
impl<'a, T> From<&'a [T]> for RSlice<'a, T>
[src]
impl<'a, T> IntoIterator for RSlice<'a, T>
[src]
type Item = &'a T
The type of the elements being iterated over.
type IntoIter = Iter<'a, T>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Iter<'a, T>
[src]
impl<'a, T> Clone for RSlice<'a, T>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'a, T> Copy for RSlice<'a, T>
[src]
impl<'a, T> Default for RSlice<'a, T>
[src]
impl<'a, T> Eq for RSlice<'a, T> where
T: Eq,
[src]
T: Eq,
impl<'a, T> Ord for RSlice<'a, T> where
T: Ord,
[src]
T: Ord,
fn cmp(&self, other: &Self) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<'a, T> PartialEq<RSlice<'a, T>> for RSlice<'a, T> where
T: PartialEq,
[src]
T: PartialEq,
impl<'a, T> PartialOrd<RSlice<'a, T>> for RSlice<'a, T> where
T: PartialOrd,
[src]
T: PartialOrd,
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
#[must_use]
fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]
fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl<'a, T> Debug for RSlice<'a, T> where
T: Debug,
[src]
T: Debug,
impl<'a, T: 'a> Deref for RSlice<'a, T>
[src]
impl<'a, T> Hash for RSlice<'a, T> where
T: Hash,
[src]
T: Hash,
fn hash<H>(&self, state: &mut H) where
H: Hasher,
[src]
H: Hasher,
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<'a, T: 'a> Borrow<[T]> for RSlice<'a, T>
[src]
impl<'a> Read for RSlice<'a, u8>
[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
[src]
fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>
[src]
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>
[src]
fn read_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>
1.36.0[src]
unsafe fn initializer(&self) -> Initializer
[src]
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn by_ref(&mut self) -> &mut Self
1.0.0[src]
fn bytes(self) -> Bytes<Self>
1.0.0[src]
fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,
1.0.0[src]
R: Read,
fn take(self, limit: u64) -> Take<Self>
1.0.0[src]
impl<'a> BufRead for RSlice<'a, u8>
[src]
fn fill_buf(&mut self) -> Result<&[u8]>
[src]
fn consume(&mut self, amt: usize)
[src]
fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize, Error>
1.0.0[src]
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
1.0.0[src]
fn split(self, byte: u8) -> Split<Self>
1.0.0[src]
fn lines(self) -> Lines<Self>
1.0.0[src]
impl<'de, T> Deserialize<'de> for RSlice<'de, T> where
&'de [T]: Deserialize<'de>,
[src]
&'de [T]: Deserialize<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
impl<'a, T> Serialize for RSlice<'a, T> where
T: Serialize,
[src]
T: Serialize,
Auto Trait Implementations
impl<'a, T> Unpin for RSlice<'a, T>
impl<'a, T> UnwindSafe for RSlice<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<'a, T> RefUnwindSafe for RSlice<'a, T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
Blanket Implementations
impl<This> GetConstGenericVTable for This where
This: StableAbi + Eq + PartialEq<This> + Debug + Send + Sync,
[src]
This: StableAbi + Eq + PartialEq<This> + Debug + Send + Sync,
const VTABLE: ConstGenericVTableFor<This>
[src]
impl<This> StableAbi for This where
This: SharedStableAbi<Kind = ValueKind>,
[src]
This: SharedStableAbi<Kind = ValueKind>,
const LAYOUT: &'static TypeLayout
[src]
const ABI_CONSTS: AbiConsts
[src]
impl<This> TransmuteElement for This where
This: ?Sized,
[src]
This: ?Sized,
unsafe fn transmute_element<T>(self) -> Self::TransmutedPtr where
Self: CanTransmuteElement<T>,
Self::Target: Sized,
[src]
Self: CanTransmuteElement<T>,
Self::Target: Sized,
impl<'a, T> BorrowOwned<'a> for T where
T: 'a + Clone,
[src]
T: 'a + Clone,
type ROwned = T
type RBorrowed = &'a T
fn r_borrow(
&'a <T as BorrowOwned<'a>>::ROwned
) -> <T as BorrowOwned<'a>>::RBorrowed
[src]
&'a <T as BorrowOwned<'a>>::ROwned
) -> <T as BorrowOwned<'a>>::RBorrowed
fn r_to_owned(
<T as BorrowOwned<'a>>::RBorrowed
) -> <T as BorrowOwned<'a>>::ROwned
[src]
<T as BorrowOwned<'a>>::RBorrowed
) -> <T as BorrowOwned<'a>>::ROwned
fn deref_borrowed(&<T as BorrowOwned<'a>>::RBorrowed) -> &T
[src]
fn deref_owned(&<T as BorrowOwned<'a>>::ROwned) -> &T
[src]
fn from_cow_borrow(&'a T) -> <T as BorrowOwned<'a>>::RBorrowed
[src]
fn from_cow_owned(<T as ToOwned>::Owned) -> <T as BorrowOwned<'a>>::ROwned
[src]
fn into_cow_borrow(<T as BorrowOwned<'a>>::RBorrowed) -> &'a T
[src]
fn into_cow_owned(<T as BorrowOwned<'a>>::ROwned) -> <T as ToOwned>::Owned
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> TypeIdentity for T where
T: ?Sized,
[src]
T: ?Sized,
type Type = T
The same type as Self. Read more
fn into_type_val(self) -> Self::Type where
Self::Type: Sized,
[src]
Self::Type: Sized,
fn into_type_ref(&self) -> &Self::Type
[src]
fn into_type_mut(&mut self) -> &mut Self::Type
[src]
fn into_type_box(self: Box<Self>) -> Box<Self::Type>
[src]
fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>
[src]
fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>
[src]
fn from_type_val(this: Self::Type) -> Self where
Self::Type: Sized,
[src]
Self::Type: Sized,
fn from_type_ref(this: &Self::Type) -> &Self
[src]
fn from_type_mut(this: &mut Self::Type) -> &mut Self
[src]
fn from_type_box(this: Box<Self::Type>) -> Box<Self>
[src]
fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>
[src]
fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>
[src]
impl<T> SelfOps for T where
T: ?Sized,
[src]
T: ?Sized,
const T: PhantomData<fn() -> Self>
[src]
const T_D: PhantomData<Self>
[src]
fn assert_ty(self, _other: PhantomData<fn() -> Self>) -> Self
[src]
fn assert_ty_ref(&self, _other: PhantomData<fn() -> Self>) -> &Self
[src]
fn assert_ty_mut(&mut self, _other: PhantomData<fn() -> Self>) -> &mut Self
[src]
fn ty_(&self) -> PhantomData<fn() -> Self>
[src]
fn ty_d(&self) -> PhantomData<Self>
[src]
fn ty_inv(&self) -> PhantomData<fn(Self) -> Self>
[src]
fn ty_inv_ref(&self) -> PhantomData<Cell<&Self>>
[src]
fn eq_id(&self, other: &Self) -> bool
[src]
fn piped<F, U>(self, f: F) -> U where
F: FnOnce(Self) -> U,
[src]
F: FnOnce(Self) -> U,
fn piped_ref<'a, F, U>(&'a self, f: F) -> U where
F: FnOnce(&'a Self) -> U,
[src]
F: FnOnce(&'a Self) -> U,
fn piped_mut<'a, F, U>(&'a mut self, f: F) -> U where
F: FnOnce(&'a mut Self) -> U,
[src]
F: FnOnce(&'a mut Self) -> U,
fn mutated<F>(self, f: F) -> Self where
F: FnOnce(&mut Self),
[src]
F: FnOnce(&mut Self),
fn observe<F>(self, f: F) -> Self where
F: FnOnce(&Self),
[src]
F: FnOnce(&Self),
fn into_<T>(self, PhantomData<fn() -> T>) -> T where
Self: Into<T>,
[src]
Self: Into<T>,
fn as_ref_<T>(&self) -> &T where
Self: AsRef<T>,
T: ?Sized,
[src]
Self: AsRef<T>,
T: ?Sized,
fn as_mut_<T>(&mut self) -> &mut T where
Self: AsMut<T>,
T: ?Sized,
[src]
Self: AsMut<T>,
T: ?Sized,
fn drop_(self)
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,