Struct KanziString

pub struct KanziString(/* private fields */);

Kanzi uses C++ std::string internally, and its internal representation differs from the Rust String type. Rust strings represent a sequence of UTF-8 code points, while C++ strings are an array of c_char.

This implies that it is possible to represent a string in Kanzi that is not valid Unicode, causing the conversion to fail on the Rust side.

To handle this case we could have used OsString or CString, but this would still require reallocating the string, as Rust might use a different allocator than C++.

Instead we “wrap” C++ strings in a wrapper (requiring only a small 8-byte allocation) and pass a pointer to this wrapper. This allows crate users to hold the string as an opaque object and use it solely for communication with Kanzi or convert it (possibly losslessly) to a Rust string via allocation.

Implementations

impl KanziString

pub const fn as_ptr(&self) -> *mut StringWrapper

pub fn as_str(&self) -> &KanziStr

impl KanziString

pub fn len(&self) -> usize

pub fn clear(&mut self)

pub fn is_empty(&self) -> bool

pub fn at(&self, pos: usize) -> Option<i8>

pub fn compare(&self, rhs: &KanziString) -> Ordering

pub fn append(&mut self, rhs: impl AsRef<KanziStr>)

pub fn from_slice(slice: &[i8]) -> KanziString

pub fn from_bytes(bytes: &[u8]) -> KanziString

pub fn from_utf8(utf8: &str) -> KanziString

pub fn from_kanzi_str(str: &KanziStr) -> KanziString

Methods from Deref<Target = KanziStr>

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

pub fn as_slice(&self) -> &[i8]

pub fn as_bytes(&self) -> &[u8]

pub fn as_utf8(&self) -> Result<&str, Utf8Error>

pub fn to_utf8_lossy(&self) -> String

pub fn to_cstring(&self) -> Option<CString>

pub fn to_kanzi_string(&self) -> KanziString

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

Trait Implementations

impl<T> AsRef<T> for KanziString

where <KanziString as Deref>::Target: AsRef<T>, T: ?Sized,

fn as_ref(&self) -> &T

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

impl Clone for KanziString

fn clone(&self) -> KanziString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataObjectConstraint for KanziString

type DataArg<'a> = &'a KanziStr

Specifies the type of an argument that provides a value to the DataObject. Generally, this type matches Self except for KanziString.

fn as_arg(&self) -> <KanziString as DataObjectConstraint>::DataArg<'_>

Converts Self to a type accepted by DataObject::set_value.

impl Debug for KanziString

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

Formats the value using the given formatter.

impl Default for KanziString

fn default() -> KanziString

Returns the “default value” for a type.

impl Deref for KanziString

type Target = KanziStr

The resulting type after dereferencing.

fn deref(&self) -> &<KanziString as Deref>::Target

Dereferences the value.

impl Display for KanziString

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

Formats the value using the given formatter.

impl Drop for KanziString

fn drop(&mut self)

Executes the destructor for this type.

impl Ord for KanziString

fn cmp(&self, rhs: &KanziString) -> 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<'a> PartialEq<&'a KanziStr> for KanziString

fn eq(&self, rhs: &&'a KanziStr) -> bool

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

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<'a> PartialEq<&'a str> for KanziString

fn eq(&self, rhs: &&'a str) -> bool

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

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<KanziStr> for KanziString

fn eq(&self, rhs: &KanziStr) -> bool

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

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<String> for KanziString

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

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

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 KanziString

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

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

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 for KanziString

fn eq(&self, rhs: &KanziString) -> bool

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

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 KanziString

fn partial_cmp(&self, rhs: &KanziString) -> 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 VariantConstraint for KanziString

type DataArg<'a> = &'a KanziStr

Specifies the type of an argument that provides a value to Variant. Generally, this type matches Self, except for KanziString, Resource, and ResourceId.

type RetArg = KanziString

Specifies the type of the return value received from Variant. Generally, this type matches Self, except for Resource.

fn as_arg(&self) -> <KanziString as VariantConstraint>::DataArg<'_>

Converts Self to a type accepted by Variant::create or Object::set_property.

impl Eq for KanziString

impl PropertyTypeConstraint for KanziString

impl Send for KanziString

impl Sync for KanziString