Struct Str

pub struct Str { /* private fields */ }

An owned, immutable in-memory representation of an Ion string.

use ion_rs::Str;
let s: Str = "hello!".into();
assert_eq!(s, "hello!");

Implementations

impl Str

pub fn len(&self) -> usize

Returns the number of UTF-8 encoded bytes in this string.

use ion_rs::Str;
let s: Str = "hello!".into();
assert_eq!(s.len(), 6);
// Note that the length returned is a number of UTF-8 bytes, not codepoints or graphemes.
let s: Str = "🚀🚀🚀".into();
assert_eq!(s.len(), 12);

pub fn is_empty(&self) -> bool

Returns true if this is the empty string (""); otherwise, returns false.

use ion_rs::Str;
let s: Str = "".into();
assert!(s.is_empty());
let s: Str = "hello!".into();
assert!(!s.is_empty());

pub fn text(&self) -> &str

Returns a &str representation of this string’s text.

use ion_rs::Str;
let s: Str = "hello, world!".into();
assert!(s.text().contains("world"));
assert!(s.text().is_ascii());

Trait Implementations

impl AsRef<str> for Str

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Str

fn clone(&self) -> Str

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Str

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

Formats the value using the given formatter.

impl Display for Str

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

Formats the value using the given formatter.

impl From<&str> for Str

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Str> for Value

fn from(string_val: Str) -> Self

Converts to this type from the input type.

impl From<String> for Str

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for Str

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Str

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<S> PartialEq<S> for Str

where S: AsRef<str>,

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Str> for &str

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<Str> for String

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Str

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Str