Struct abi_stable::std_types::string::RString[−][src]

#[repr(C)]
pub struct RString { /* fields omitted */ }

Expand description

Ffi-safe equivalent of std::string::String.

Example

This defines a function returning the last word of an RString.

use abi_stable::{sabi_extern_fn, std_types::RString};

#[sabi_extern_fn]
fn first_word(phrase: RString) -> RString {
    match phrase.split_whitespace().next_back() {
        Some(x) => x.into(),
        None => RString::new(),
    }
}

Implementations

[src]

impl RString

[src]

pub const fn new() -> Self

Creates a new, empty RString.

Example

use abi_stable::std_types::RString;

let str = RString::new();

assert_eq!(&str[..], "");

[src]

pub fn with_capacity(cap: usize) -> Self

Creates a new, empty RString with the capacity for cap bytes without reallocating.

Example

use abi_stable::std_types::RString;

let str = RString::with_capacity(10);

assert_eq!(&str[..], "");
assert_eq!(str.capacity(), 10);

[src]

pub fn slice<'a, I>(&'a self, i: I) -> RStr<'a> where
str: Index<I, Output = str>,

For slicing into RStrs.

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"));

[src]

pub fn as_str(&self) -> &str

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);

[src]

pub const fn as_rstr(&self) -> RStr<'_>

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),);

[src]

pub const fn len(&self) -> usize

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);

[src]

pub const fn is_empty(&self) -> bool

Returns whether the RString is empty.

Example

use abi_stable::std_types::RString;

assert_eq!(RString::from("").is_empty(), true);
assert_eq!(RString::from("a").is_empty(), false);
assert_eq!(RString::from("Regular").is_empty(), false);

[src]

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

Gets a raw pointer to the start of this RString’s buffer.

[src]

pub const fn capacity(&self) -> usize

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);

[src]

pub const unsafe fn from_utf8_unchecked(vec: RVec<u8>) -> Self

An unchecked conversion from a RVec<u8> to an RString.

Safety

This has the same safety requirements as String::from_utf8_unchecked .

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");
}

[src]

pub fn from_utf8<V>(vec: V) -> Result<Self, FromUtf8Error> where
V: Into<RVec<u8>>,

Converts the vec vector of bytes to an RString.

Errors

This returns a Err(FromUtf8Error{..}) if vec is 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());

[src]

pub fn from_utf16(s: &[u16 ]) -> Result<Self, FromUtf16Error>

Decodes a utf-16 encoded &[u16] to an RString.

Errors

This returns a Err(::std::string::FromUtf16Error{..}) if vec is 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),);

[src]

pub fn into_bytes(self) -> RVec<u8>ⓘ
Notable traits for RVec<u8>
`impl Write for RVec<u8>`

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);

[src]

pub fn into_string(self) -> String

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);

[src]

pub fn to_string(&self) -> String

Copies the RString into a String.

Example

use abi_stable::std_types::RString;

assert_eq!(RString::from("world").to_string(), String::from("world"));

[src]

pub fn reserve(&mut self, additional: usize)

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);

[src]

pub fn shrink_to_fit(&mut self)

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);

[src]

pub fn reserve_exact(&mut self, additional: usize)

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);

[src]

pub fn push(&mut self, ch: char)

Appends ch 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");

[src]

pub fn push_str(&mut self, str: &str)

Appends 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");

[src]

pub fn pop(&mut self) -> Option<char>

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);

[src]

pub fn remove(&mut self, idx: usize) -> char

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");

[src]

pub fn insert(&mut self, idx: usize, ch: char)

Insert the ch character at the ìdx 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");

[src]

pub fn insert_str(&mut self, idx: usize, string: &str)

Insert the string at the ìdx 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");

[src]

pub fn retain<F>(&mut self, pred: F) where
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");
}

[src]

pub fn clear(&mut self)

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(), "");

[src]

impl RString

[src]

pub fn drain(&mut self, range: I) -> Drain<'_>ⓘ
Notable traits for Drain<'a>
`impl<'a> Iterator for Drain<'a> type Item = char;`
where
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 either are 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

[src]

impl AsRef<[u8 ]> for RString

[src]

fn as_ref(&self) -> &[u8 ]ⓘ
Notable traits for &'_ [u8 ]
`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Performs the conversion.

[src]

impl AsRef<str> for RString

[src]

fn as_ref(&self) -> &str

Performs the conversion.

[src]

impl Borrow<str> for RString

[src]

fn borrow(&self) -> &str

Immutably borrows from an owned value. Read more

[src]

impl Clone for RString

[src]

fn clone(&self) -> RString

Returns a copy of the value. Read more

1.0.0[src]

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

Performs copy-assignment from source. Read more

[src]

impl Debug for RString

[src]

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

Formats the value using the given formatter. Read more

[src]

impl Default for RString

Returns an empty RString

[src]

fn default() -> Self

Returns the “default value” for a type. Read more

[src]

impl Deref for RString

type Target = str

The resulting type after dereferencing.

[src]

fn deref(&self) -> &Self::Target

Dereferences the value.

[src]

impl<'de> Deserialize<'de> for RString

[src]

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

[src]

impl Display for RString

[src]

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

Formats the value using the given formatter. Read more

[src]

impl From<&'_ str> for RString

[src]

fn from(this: &str) -> Self

Performs the conversion.

[src]

impl<'a> From<&'a RString> for RCow<'a, str>

[src]

fn from(this: &'a RString) -> Self

Performs the conversion.

[src]

impl<'a> From<Cow<'a, str>> for RString

[src]

fn from(this: Cow<'a, str>) -> Self

Performs the conversion.

[src]

impl From<RStr<'_>> for RString

[src]

fn from(this: RStr<'_>) -> RString

Performs the conversion.

[src]

impl<'a> From<RString> for RCow<'a, str>

[src]

fn from(this: RString) -> Self

Performs the conversion.

[src]

impl From<RString> for String

[src]

fn from(this: RString) -> String

Performs the conversion.

[src]

impl<'a> From<RString> for Cow<'a, str>

[src]

fn from(this: RString) -> Cow<'a, str>

Performs the conversion.

[src]

impl From<String> for RString

[src]

fn from(this: String) -> RString

Performs the conversion.

[src]

impl<'a> FromIterator<&'a char> for RString

[src]

fn from_iter(iter: I) -> Self where
I: IntoIterator<Item = &'a char>,

Creates a value from an iterator. Read more

[src]

impl FromIterator<char> for RString

[src]

fn from_iter(iter: I) -> Self where
I: IntoIterator<Item = char>,

Creates a value from an iterator. Read more

[src]

impl FromStr for RString

type Err = <String as FromStr>::Err

The associated error which can be returned from parsing.

[src]

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

[src]

impl GetStaticEquivalent_ for RString

type StaticEquivalent = _static_RString

[src]

impl Hash for RString

[src]

fn hash<H>(&self, state: &mut H) where
H: Hasher,

Feeds this value into the given Hasher. Read more

1.3.0[src]

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

[src]

impl IntoIterator for RString

type Item = char

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

[src]

fn into_iter(self) -> IntoIterⓘ
Notable traits for IntoIter
`impl Iterator for IntoIter type Item = char;`

Creates an iterator from a value. Read more

[src]

impl IntoReprRust for RString

type ReprRust = String

The #[repr(Rust)] equivalent.

[src]

fn into_rust(self) -> Self::ReprRust

Performs the conversion

[src]

impl Ord for RString

[src]

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0[src]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values. Read more

1.21.0[src]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values. Read more

1.50.0[src]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

[src]

impl PartialEq<&'_ str> for RString

[src]

fn eq(&self, other: &&str) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<Cow<'_, str>> for RString

[src]

fn eq(&self, other: &Cow<'_, str>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RCow<'_, str>> for RString

[src]

fn eq(&self, other: &RCow<'_, str>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RStr<'_>> for RString

[src]

fn eq(&self, other: &RStr<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for String

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for str

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for &str

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for RStr<'_>

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for Cow<'_, str>

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for RCow<'_, str>

[src]

fn eq(&self, other: &RString) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<RString> for RString

[src]

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<String> for RString

[src]

fn eq(&self, other: &String) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialEq<str> for RString

[src]

fn eq(&self, other: &str) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0[src]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

[src]

impl PartialOrd<&'_ str> for RString

[src]

fn partial_cmp(&self, other: &&str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<Cow<'_, str>> for RString

[src]

fn partial_cmp(&self, other: &Cow<'_, str>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RCow<'_, str>> for RString

[src]

fn partial_cmp(&self, other: &RCow<'_, str>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RStr<'_>> for RString

[src]

fn partial_cmp(&self, other: &RStr<'_>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for String

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for str

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for &str

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for RStr<'_>

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for Cow<'_, str>

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for RCow<'_, str>

[src]

fn partial_cmp(&self, other: &RString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<RString> for RString

[src]

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<String> for RString

[src]

fn partial_cmp(&self, other: &String) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl PartialOrd<str> for RString

[src]

fn partial_cmp(&self, other: &str) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more

1.0.0[src]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0[src]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0[src]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0[src]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

[src]

impl Serialize for RString

[src]

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

[src]

impl StableAbi for RString

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern. Read more

[src]

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

[src]

const ABI_CONSTS: AbiConsts

const-equivalents of the associated types.

[src]

impl Write for RString

[src]

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded. Read more

[src]

fn write_char(&mut self, c: char) -> Result

Writes a char into this writer, returning whether the write succeeded. Read more

1.0.0[src]

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait. Read more

[src]

impl Eq for RString

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

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<'a, T> BorrowOwned<'a> for T where
T: 'a + Clone,

type ROwned = T

The owned type, stored in RCow::Owned

type RBorrowed = &'a T

The borrowed type, stored in RCow::Borrowed

[src]

pub fn r_borrow(
&'a <T as BorrowOwned<'a>>::ROwned
) -> <T as BorrowOwned<'a>>::RBorrowed

[src]

pub fn r_to_owned(
<T as BorrowOwned<'a>>::RBorrowed
) -> <T as BorrowOwned<'a>>::ROwned

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> GetWithMetadata for T

type ForSelf = WithMetadata_<T, T>

This is always WithMetadata_<Self, Self>

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<S> ROExtAcc for S

[src]

pub fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

Gets a reference to a field, determined by offset. Read more

[src]

pub fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

Gets a muatble reference to a field, determined by offset. Read more

[src]

pub fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

Gets a const pointer to a field, the field is determined by offset. Read more

[src]

pub fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F

Gets a mutable pointer to a field, determined by offset. Read more

[src]

impl<S> ROExtOps<Aligned> for S

[src]

pub fn f_replace<F>(
 &mut self,
 offset: FieldOffset<S, F, Aligned>,
 value: F
) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

[src]

pub fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Aligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

[src]

pub fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> F where
F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

[src]

impl<S> ROExtOps<Unaligned> for S

[src]

pub fn f_replace<F>(
 &mut self,
 offset: FieldOffset<S, F, Unaligned>,
 value: F
) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

[src]

pub fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

[src]

pub fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> F where
F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

[src]

impl<T> SelfOps for T where
T: ?Sized,

[src]

fn eq_id(&self, other: &Self) -> bool

Compares the address of self with the address of other. Read more

[src]

fn piped<F, U>(self, f: F) -> U where
F: FnOnce(Self) -> U,

Emulates the pipeline operator, allowing method syntax in more places. Read more

[src]

fn piped_ref<'a, F, U>(&'a self, f: F) -> U where
F: FnOnce(&'a Self) -> U,

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

[src]

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> U where
F: FnOnce(&'a mut Self) -> U,

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self. Read more

[src]

fn mutated<F>(self, f: F) -> Self where
F: FnOnce(&mut Self),

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

[src]

fn observe<F>(self, f: F) -> Self where
F: FnOnce(&Self),

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

[src]

fn into_<T>(self) -> T where
Self: Into<T>,

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

[src]

fn as_ref_<T>(&self) -> &T where
Self: AsRef<T>,
T: ?Sized,

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

[src]

fn as_mut_<T>(&mut self) -> &mut T where
Self: AsMut<T>,
T: ?Sized,

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

[src]

fn drop_(self)

Drops self using method notation. Alternative to std::mem::drop. Read more

[src]

impl<T> StringExt for T where
T: Borrow<str> + ?Sized,

[src]

fn previous_char_boundary(&self, index: usize) -> usize

Returns the previous character boundary, stopping at 0. Read more

[src]

fn next_char_boundary(&self, index: usize) -> usize

Returns the next character boundary. Read more

[src]

fn left_char_boundary(&self, index: usize) -> usize

Returns the closest characted boundary left of index(including index). Read more

[src]

fn right_char_boundary(&self, index: usize) -> usize

Returns the closest characted boundary right of index(including index). Read more

[src]

fn split_while<P, T>(&'a self, mapper: P) -> SplitWhile<'a, P, T> where
T: Eq + Clone,
P: FnMut(char) -> T,

Returns an iterator over substrings whose characters were mapped to the same key by mapper. Read more

[src]

fn rsplit_while<P, T>(&'a self, mapper: P) -> RSplitWhile<'a, P, T> where
T: Eq + Clone,
P: FnMut(char) -> T,

A variation of split_while that iterates from the right(the order of substrings is reversed). Read more

[src]

fn get_nth_char_index(&self, nth: usize) -> Option<usize>

The byte index of the nth character Read more

[src]

fn nth_char_index(&self, nth: usize) -> usize

The byte index of the nth character Read more

[src]

fn nth_char(&self, nth: usize) -> Option<char>

Returns the nth character in the str. Read more

[src]

fn first_chars(&self, n: usize) -> &str

Returns a string containing the first n chars. Read more

[src]

fn last_chars(&self, n: usize) -> &str

Returns a string containing the last n chars Read more

[src]

fn from_nth_char(&self, n: usize) -> &str

Returns the string from the nth character Read more

[src]

fn calc_len_utf16(&self) -> usize

Returns the length of the string in utf16 Read more

[src]

fn get_char_at(&self, at_byte: usize) -> Option<char>

Returns the character at the at_byte index inside of the string, returning None if the index is outside the string. Read more

[src]

fn char_indices_to(&self, to: usize) -> CharIndices<'_>

Returns an iterator over (index,char) pairs up to (but not including) the char at the to byte. Read more

[src]

fn char_indices_from(&self, from: usize) -> CharIndicesFrom<'_>

Returns an iterator over (index, char) pairs, starting from the from byte. Read more

[src]

fn left_pad(&self, how_much: usize) -> String

This is supported on crate feature alloc only.

Pads the string on the left with how_much additional spaces. Read more

[src]

fn left_padder(&'a self, how_much: usize) -> LeftPadder<'a>

Returns a value that pads the string on the left with how_much additional spaces in its Display impl. Read more

[src]

fn line_indentation(&self) -> usize

This is supported on core_str_methods or crate feature alloc only.

The indentation of the first line. Read more

[src]

fn min_indentation(&self) -> usize

This is supported on core_str_methods or crate feature alloc only.

The minimum indentation of the string, ignoring lines that only contain whitespace. Read more

[src]

fn max_indentation(&self) -> usize

This is supported on core_str_methods or crate feature alloc only.

The maximum indentation of the string, ignoring lines that only contain whitespace. Read more

[src]

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

[src]

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

[src]

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

[src]

impl<T> ToString for T where
T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

impl<This> TransmuteElement for This where
This: ?Sized,

[src]

unsafe fn transmute_element<T>(
self
) -> <Self as CanTransmuteElement<T>>::TransmutedPtr where
Self: CanTransmuteElement<T>,

Transmutes the element type of this pointer.. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

[src]

impl<T> TypeIdentity for T where
T: ?Sized,

type Type = T

This is always Self.

[src]

fn into_type(self) -> Self::Type where
Self::Type: Sized,

Converts a value back to the original type.

[src]

fn as_type(&self) -> &Self::Type

Converts a reference back to the original type.

[src]

fn as_type_mut(&mut self) -> &mut Self::Type

Converts a mutable reference back to the original type.

[src]

fn into_type_box(self: Box<Self, Global>) -> Box<Self::Type, Global>

This is supported on crate feature alloc only.

Converts a box back to the original type.

[src]

fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>

This is supported on crate feature alloc only.

Converts an Arc back to the original type. Read more

[src]

fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>

This is supported on crate feature alloc only.

Converts an Rc back to the original type. Read more

[src]

fn from_type(this: Self::Type) -> Self where
Self::Type: Sized,

Converts a value back to the original type.

[src]

fn from_type_ref(this: &Self::Type) -> &Self

Converts a reference back to the original type.

[src]

fn from_type_mut(this: &mut Self::Type) -> &mut Self

Converts a mutable reference back to the original type.

[src]

fn from_type_box(this: Box<Self::Type, Global>) -> Box<Self, Global>

This is supported on crate feature alloc only.

Converts a box back to the original type.

[src]

fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>

This is supported on crate feature alloc only.

Converts an Arc back to the original type.

[src]

fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>

This is supported on crate feature alloc only.

Converts an Rc back to the original type.

[src]

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,

[src]

Struct abi_stable::std_types::string::RString[−][src]

Implementations

impl RString

pub const fn new() -> Self

pub fn with_capacity(cap: usize) -> Self

pub fn slice<'a, I>(&'a self, i: I) -> RStr<'a> where str: Index<I, Output = str>,

pub fn as_str(&self) -> &str

pub const fn as_rstr(&self) -> RStr<'_>

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

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

pub const fn capacity(&self) -> usize

pub const unsafe fn from_utf8_unchecked(vec: RVec<u8>) -> Self

pub fn from_utf8<V>(vec: V) -> Result<Self, FromUtf8Error> where V: Into<RVec<u8>>,

pub fn from_utf16(s: &[u16]) -> Result<Self, FromUtf16Error>

pub fn into_bytes(self) -> RVec<u8>ⓘNotable traits for RVec<u8>impl Write for RVec<u8>

pub fn into_string(self) -> String

pub fn to_string(&self) -> String

pub fn reserve(&mut self, additional: usize)

pub fn shrink_to_fit(&mut self)

pub fn reserve_exact(&mut self, additional: usize)

pub fn push(&mut self, ch: char)

pub fn push_str(&mut self, str: &str)

pub fn pop(&mut self) -> Option<char>

pub fn remove(&mut self, idx: usize) -> char

pub fn insert(&mut self, idx: usize, ch: char)

pub fn insert_str(&mut self, idx: usize, string: &str)

pub fn retain<F>(&mut self, pred: F) where F: FnMut(char) -> bool,

pub fn clear(&mut self)

impl RString

pub fn drain<I>(&mut self, range: I) -> Drain<'_>ⓘNotable traits for Drain<'a>impl<'a> Iterator for Drain<'a> type Item = char; where str: Index<I, Output = str>,

Trait Implementations

impl AsRef<[u8]> for RString

fn as_ref(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

impl AsRef<str> for RString

fn as_ref(&self) -> &str

impl Borrow<str> for RString

fn borrow(&self) -> &str

impl Clone for RString

fn clone(&self) -> RString

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

impl Debug for RString

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

impl Default for RString

fn default() -> Self

impl Deref for RString

type Target = str

fn deref(&self) -> &Self::Target

impl<'de> Deserialize<'de> for RString

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,

impl Display for RString

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

impl From<&'_ str> for RString

fn from(this: &str) -> Self

impl<'a> From<&'a RString> for RCow<'a, str>

fn from(this: &'a RString) -> Self

impl<'a> From<Cow<'a, str>> for RString

fn from(this: Cow<'a, str>) -> Self

impl From<RStr<'_>> for RString

fn from(this: RStr<'_>) -> RString

impl<'a> From<RString> for RCow<'a, str>

fn from(this: RString) -> Self

impl From<RString> for String

fn from(this: RString) -> String

impl<'a> From<RString> for Cow<'a, str>

fn from(this: RString) -> Cow<'a, str>

impl From<String> for RString

fn from(this: String) -> RString

impl<'a> FromIterator<&'a char> for RString

fn from_iter<I>(iter: I) -> Self where I: IntoIterator<Item = &'a char>,

impl FromIterator<char> for RString

fn from_iter<I>(iter: I) -> Self where I: IntoIterator<Item = char>,

impl FromStr for RString

type Err = <String as FromStr>::Err

fn from_str(s: &str) -> Result<Self, Self::Err>

impl GetStaticEquivalent_ for RString

type StaticEquivalent = _static_RString

impl Hash for RString

fn hash<H>(&self, state: &mut H) where H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

pub fn slice<'a, I>(&'a self, i: I) -> RStr<'a> where
str: Index<I, Output = str>,

pub fn from_utf8<V>(vec: V) -> Result<Self, FromUtf8Error> where
V: Into<RVec<u8>>,

pub fn from_utf16(s: &[u16 ]) -> Result<Self, FromUtf16Error>

pub fn into_bytes(self) -> RVec<u8>ⓘ
Notable traits for RVec<u8>
`impl Write for RVec<u8>`

pub fn retain<F>(&mut self, pred: F) where
F: FnMut(char) -> bool,

pub fn drain<I>(&mut self, range: I) -> Drain<'_>ⓘ
Notable traits for Drain<'a>
`impl<'a> Iterator for Drain<'a> type Item = char;`
where
str: Index<I, Output = str>,

impl AsRef<[u8 ]> for RString

fn as_ref(&self) -> &[u8 ]ⓘ
Notable traits for &'_ [u8 ]
`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
D: Deserializer<'de>,

fn from_iter<I>(iter: I) -> Self where
I: IntoIterator<Item = &'a char>,

fn from_iter<I>(iter: I) -> Self where
I: IntoIterator<Item = char>,

fn hash<H>(&self, state: &mut H) where
H: Hasher,

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

fn into_iter(self) -> IntoIterⓘ
Notable traits for IntoIter
`impl Iterator for IntoIter type Item = char;`