[−][src]Struct abi_stable::std_types::string::RString
Ffi-safe equivalent of ::std::string::String
Example
This defines a function returning the last word of an RString.
use abi_stable::{ std_types::RString, sabi_extern_fn, }; #[sabi_extern_fn] fn first_word(phrase:RString)->RString{ match phrase.split_whitespace().next_back() { Some(x)=>x.into(), None=>RString::new(), } }
Methods
impl RString
[src]
pub const fn new() -> Self
[src]
Creates a new,empty RString.
Example
use abi_stable::std_types::RString; let str=RString::new(); assert_eq!(&str[..],"");
pub fn with_capacity(cap: usize) -> Self
[src]
Creates a new,
empty RString with the capacity to push strings that add up to cap
bytes.
Example
use abi_stable::std_types::RString; let str=RString::with_capacity(10); assert_eq!(&str[..],""); assert_eq!(str.capacity(),10);
pub fn slice<'a, I>(&'a self, i: I) -> RStr<'a> where
str: Index<I, Output = str>,
[src]
str: Index<I, Output = str>,
For slicing into RStr
s.
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::{RStr,RString}; let str=RString::from("What is that."); assert_eq!(str.slice(..),RStr::from("What is that.")); assert_eq!(str.slice(..4),RStr::from("What")); assert_eq!(str.slice(4..),RStr::from(" is that.")); assert_eq!(str.slice(4..7),RStr::from(" is"));
pub fn as_str(&self) -> &str
[src]
Creates a &str
with access to all the characters of the RString
.
Example
use abi_stable::std_types::RString; let str="What is that."; assert_eq!(RString::from(str).as_str(),str);
pub const fn as_rstr(&self) -> RStr
[src]
Creates an RStr<'_>
with access to all the characters of the RString
.
Example
use abi_stable::std_types::{RStr,RString}; let str="What is that."; assert_eq!( RString::from(str).as_rstr(), RStr::from(str), );
pub const fn len(&self) -> usize
[src]
Returns the current length (in bytes) of the RString.
Example
use abi_stable::std_types::RString; assert_eq!(RString::from("").len(),0); assert_eq!(RString::from("a").len(),1); assert_eq!(RString::from("Regular").len(),7);
pub const fn as_ptr(&self) -> *const u8
[src]
Gets a raw pointer to the start of this RString's buffer.
pub const fn capacity(&self) -> usize
[src]
Returns the current capacity (in bytes) of the RString.
Example
use abi_stable::std_types::RString; let mut str=RString::with_capacity(13); assert_eq!(str.capacity(),13); str.push_str("What is that."); assert_eq!(str.capacity(),13); str.push(' '); assert_ne!(str.capacity(),13);
pub const unsafe fn from_utf8_unchecked(vec: RVec<u8>) -> Self
[src]
An unchecked conversion from a RVec<u8>
to an RString
.
Examples
use abi_stable::std_types::{RString,RVec}; let bytes=RVec::from("hello".as_bytes()); unsafe{ assert_eq!( RString::from_utf8_unchecked(bytes).as_str(), "hello" ); }
pub fn from_utf8<V>(vec: V) -> Result<Self, FromUtf8Error> where
V: Into<RVec<u8>>,
[src]
V: Into<RVec<u8>>,
Converts the vec
vector of bytes to an RString.
Errors
This will return a Err(FromUtf8Error{..})
if vec
was not valid utf-8.
Examples
use abi_stable::std_types::{RString,RVec}; let bytes_ok=RVec::from("hello".as_bytes()); let bytes_err=RVec::from(vec![255]); assert_eq!( RString::from_utf8(bytes_ok).unwrap(), RString::from("hello") ); assert!( RString::from_utf8(bytes_err).is_err() );
pub fn from_utf16(s: &[u16]) -> Result<Self, FromUtf16Error>
[src]
Decodes a utf-16 encoded &[u16]
to an RString.
Errors
This will return a Err(::std::string::FromUtf16Error{..})
if vec
was not valid utf-8.
Example
use abi_stable::std_types::RString; let str="What the 😈."; let str_utf16=str.encode_utf16().collect::<Vec<u16>>(); assert_eq!( RString::from_utf16(&str_utf16).unwrap(), RString::from(str), );
pub fn into_bytes(self) -> RVec<u8>
[src]
Cheap conversion of this RString
to a RVec<u8>
Example
use abi_stable::std_types::{RString,RVec}; let bytes=RVec::from("hello".as_bytes()); let str=RString::from("hello"); assert_eq!(str.into_bytes(),bytes);
pub fn into_string(self) -> String
[src]
Converts this RString to a String.
Allocation
If this is invoked outside of the dynamic library/binary that created it,
it will allocate a new String
and move the data into it.
Example
use abi_stable::std_types::RString; let std_str=String::from("hello"); let str=RString::from("hello"); assert_eq!(str.into_string(),std_str);
pub fn to_string(&self) -> String
[src]
Copies the RString
into a String
.
Example
use abi_stable::std_types::RString; assert_eq!(RString::from("world").to_string(), String::from("world"));
pub fn reserve(&mut self, additional: usize)
[src]
Reserves àdditional
additional capacity for any extra string data.
This may reserve more than necessary for the additional capacity.
Example
use abi_stable::std_types::RString; let mut str=RString::new(); str.reserve(10); assert!(str.capacity()>=10);
pub fn shrink_to_fit(&mut self)
[src]
Shrinks the capacity of the RString to match its length.
Example
use abi_stable::std_types::RString; let mut str=RString::with_capacity(100); str.push_str("nope"); str.shrink_to_fit(); assert_eq!(str.capacity(),4);
pub fn reserve_exact(&mut self, additional: usize)
[src]
Reserves àdditional
additional capacity for any extra string data.
Prefer using reserve
for most situations.
Example
use abi_stable::std_types::RString; let mut str=RString::new(); str.reserve_exact(10); assert_eq!(str.capacity(),10);
pub fn push(&mut self, ch: char)
[src]
Appends the ch
char at the end of this RString.
Example
use abi_stable::std_types::RString; let mut str=RString::new(); str.push('O'); str.push('O'); str.push('P'); assert_eq!(str.as_str(),"OOP");
pub fn push_str(&mut self, s: &str)
[src]
Appends the s
&str at the end of this RString.
Example
use abi_stable::std_types::RString; let mut str=RString::new(); str.push_str("green "); str.push_str("frog"); assert_eq!(str.as_str(),"green frog");
pub fn pop(&mut self) -> Option<char>
[src]
Removes the last character, returns Some(_) if this RString is not empty, otherwise returns None.
Example
use abi_stable::std_types::{RString,RVec}; let mut str=RString::from("yep"); assert_eq!(str.pop(),Some('p')); assert_eq!(str.pop(),Some('e')); assert_eq!(str.pop(),Some('y')); assert_eq!(str.pop(),None);
pub fn remove(&mut self, idx: usize) -> char
[src]
Removes and returns the character starting at the idx
byte position,
Panics
Panics if the index is out of bounds or if it is not on a char boundary.
Example
use abi_stable::std_types::{RString,RVec}; let mut str=RString::from("Galileo"); assert_eq!(str.remove(3),'i'); assert_eq!(str.as_str(),"Galleo"); assert_eq!(str.remove(4),'e'); assert_eq!(str.as_str(),"Gallo");
pub fn insert(&mut self, idx: usize, ch: char)
[src]
Insert the ch
character at the ìnx
byte position.
Panics
Panics if the index is out of bounds or if it is not on a char boundary.
Example
use abi_stable::std_types::{RString,RVec}; let mut str=RString::from("Cap"); str.insert(1,'r'); assert_eq!(str.as_str(),"Crap"); str.insert(4,'p'); assert_eq!(str.as_str(),"Crapp"); str.insert(5,'y'); assert_eq!(str.as_str(),"Crappy");
pub fn insert_str(&mut self, idx: usize, string: &str)
[src]
Insert the s
string at the ìnx
byte position.
Panics
Panics if the index is out of bounds or if it is not on a char boundary.
Example
use abi_stable::std_types::{RString,RVec}; let mut str=RString::from("rust"); str.insert_str(0,"T"); assert_eq!(str.as_str(),"Trust"); str.insert_str(5," the source"); assert_eq!(str.as_str(),"Trust the source"); str.insert_str(5," the types in"); assert_eq!(str.as_str(),"Trust the types in the source");
pub fn retain<F>(&mut self, pred: F) where
F: FnMut(char) -> bool,
[src]
F: FnMut(char) -> bool,
Retains only the characters that satisfy the pred
predicate
This means that a character will be removed if pred(that_character)
returns false.
Example
use abi_stable::std_types::{RString,RVec}; { let mut str=RString::from("There were 10 people."); str.retain(|c| !c.is_numeric() ); assert_eq!(str.as_str(),"There were people."); } { let mut str=RString::from("There were 10 people."); str.retain(|c| !c.is_whitespace() ); assert_eq!(str.as_str(),"Therewere10people."); } { let mut str=RString::from("There were 10 people."); str.retain(|c| c.is_numeric() ); assert_eq!(str.as_str(),"10"); }
pub fn clear(&mut self)
[src]
Turns this into an empty RString,keeping the same allocated buffer.
Example
use abi_stable::std_types::{RString,RVec}; let mut str=RString::from("Nurse"); assert_eq!(str.as_str(),"Nurse"); str.clear(); assert_eq!(str.as_str(),"");
impl RString
[src]
ⓘImportant traits for Drain<'a>pub fn drain<I>(&mut self, range: I) -> Drain where
str: Index<I, Output = str>,
[src]
str: Index<I, Output = str>,
Creates an iterator that yields the chars in the range
,
removing the characters in that range in the process.
Panic
Panics if the start or end of the range are not on a on a char boundary, or if it is out of bounds.
Example
use abi_stable::std_types::RString; let orig="Not a single way"; { let mut str=RString::from(orig); assert_eq!( str.drain(..).collect::<String>(), orig, ); assert_eq!(str.as_str(),""); } { let mut str=RString::from(orig); assert_eq!( str.drain(..4).collect::<String>(), "Not ", ); assert_eq!(str.as_str(),"a single way"); } { let mut str=RString::from(orig); assert_eq!( str.drain(4..).collect::<String>(), "a single way", ); assert_eq!(str.as_str(),"Not "); } { let mut str=RString::from(orig); assert_eq!( str.drain(4..13).collect::<String>(), "a single ", ); assert_eq!(str.as_str(),"Not way"); }
Trait Implementations
impl AsRef<[u8]> for RString
[src]
impl AsRef<str> for RString
[src]
impl Borrow<str> for RString
[src]
impl Clone for RString
[src]
impl Debug for RString
[src]
impl Default for RString
[src]
Returns an empty RString
impl Deref for RString
[src]
impl<'de> Deserialize<'de> for RString
[src]
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,
[src]
D: Deserializer<'de>,
impl Display for RString
[src]
impl Eq for RString
[src]
impl<'a> From<&'a RString> for RCow<'a, str>
[src]
impl<'a> From<&'a str> for RString
[src]
impl<'a> From<Cow<'a, str>> for RString
[src]
impl<'a> From<RString> for RCow<'a, str>
[src]
impl From<String> for RString
[src]
impl<'a> FromIterator<&'a char> for RString
[src]
fn from_iter<I>(iter: I) -> Self where
I: IntoIterator<Item = &'a char>,
[src]
I: IntoIterator<Item = &'a char>,
impl FromIterator<char> for RString
[src]
fn from_iter<I>(iter: I) -> Self where
I: IntoIterator<Item = char>,
[src]
I: IntoIterator<Item = char>,
impl FromStr for RString
[src]
type Err = <String as FromStr>::Err
The associated error which can be returned from parsing.
fn from_str(s: &str) -> Result<Self, Self::Err>
[src]
impl GetStaticEquivalent_ for RString
[src]
type StaticEquivalent = _static_RString
impl Hash for RString
[src]
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> Into<Cow<'a, str>> for RString
[src]
impl<'a> Into<RString> for RStr<'a>
[src]
impl Into<String> for RString
[src]
impl IntoIterator for RString
[src]
type Item = char
The type of the elements being iterated over.
type IntoIter = IntoIter
Which kind of iterator are we turning this into?
ⓘImportant traits for IntoIterfn into_iter(self) -> IntoIter
[src]
impl IntoReprRust for RString
[src]
impl Ord for RString
[src]
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 PartialEq<RString> for RString
[src]
impl PartialOrd<RString> for RString
[src]
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 Serialize for RString
[src]
impl SharedStableAbi for RString
[src]
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 Write for RString
[src]
Auto Trait Implementations
impl RefUnwindSafe for RString
impl Send for RString
impl Sync for RString
impl Unpin for RString
impl UnwindSafe for RString
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
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<'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> DeserializeOwned for T where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
impl<T> From<T> for T
[src]
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<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
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> 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<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<T> StringExt for T where
T: Borrow<str> + ?Sized,
[src]
T: Borrow<str> + ?Sized,
fn previous_char_boundary(&self, index: usize) -> usize
[src]
fn next_char_boundary(&self, index: usize) -> usize
[src]
fn left_char_boundary(&self, index: usize) -> usize
[src]
fn right_char_boundary(&self, index: usize) -> usize
[src]
fn get_offset_inside_of(&self, parent: &str) -> Option<usize>
[src]
fn offset_inside_of(&self, parent: &str) -> usize
[src]
fn is_substring_of(&self, parent: &str) -> bool
[src]
fn split_while<P, T>(&'a self, mapper: P) -> SplitWhile<'a, P, T> where
P: FnMut(char) -> T,
T: Clone + Eq,
[src]
P: FnMut(char) -> T,
T: Clone + Eq,
fn rsplit_while<P, T>(&'a self, mapper: P) -> RSplitWhile<'a, P, T> where
P: FnMut(char) -> T,
T: Clone + Eq,
[src]
P: FnMut(char) -> T,
T: Clone + Eq,
fn get_nth_char_index(&self, n: usize) -> Option<usize>
[src]
fn nth_char_index(&self, n: usize) -> usize
[src]
fn nth_char(&self, n: usize) -> Option<char>
[src]
fn first_chars(&self, n: usize) -> &str
[src]
fn last_chars(&self, n: usize) -> &str
[src]
fn from_nth_char(&self, n: usize) -> &str
[src]
fn calc_len_utf16(&self) -> usize
[src]
fn get_char_at(&self, at_byte: usize) -> Option<char>
[src]
fn char_indices_to(&self, to: usize) -> CharIndices
[src]
fn char_indices_from(&self, from: usize) -> CharIndicesFrom
[src]
fn left_pad(&self, how_much: usize) -> String
[src]
fn left_padder(&'a self, how_much: usize) -> LeftPadder<'a>
[src]
fn line_indentation(&self) -> usize
[src]
fn min_indentation(&self) -> usize
[src]
fn max_indentation(&self) -> usize
[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> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
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<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, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The error type returned when the conversion fails.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
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,