Struct UChar

pub struct UChar { /* private fields */ }

The implementation of the ICU UChar*.

While the original type is defined in umachine.h, most useful functions for manipulating UChar* are in fact here.

The first thing you probably want to do is to start from a UTF-8 rust string, produce a UChar. This is necessarily done with a conversion. See the TryFrom implementations in this crate for that.

Implements UChar* from ICU.

Implementations

impl UChar

pub fn new_with_capacity(capacity: usize) -> UChar

Allocates a new UChar with given capacity.

Capacity and size must always be the same with UChar when used for interacting with low-level code.

pub unsafe fn clone_from_raw_parts(rep: *mut UChar, len: i32) -> UChar

Creates a new crate::UChar from its low-level representation, a buffer pointer and a buffer size.

Does not take ownership of the buffer that was passed in.

DO NOT USE UNLESS YOU HAVE NO OTHER CHOICE.

Safety

rep must point to an initialized sequence of at least len UChars.

pub fn make_z(&mut self)

Converts into a zeroed-out string.

This is a very weird ICU API thing, where there apparently exists a zero-terminated UChar*.

pub fn as_c_ptr(&self) -> *const UChar

Returns the constant pointer to the underlying C representation. Intended for use in low-level code.

pub fn len(&self) -> usize

Returns the length of the string, in code points.

pub fn is_empty(&self) -> bool

Returns whether the string is empty.

pub fn as_mut_c_ptr(&mut self) -> *mut UChar

Returns the underlying representation as a mutable C representation. Caller MUST ensure that the representation won’t be reallocated as result of adding anything to it, and that it is correctly sized, or bad things will happen.

pub fn resize(&mut self, new_size: usize)

Resizes this string to match new_size.

If the string is made longer, the new space is filled with zeroes.

pub fn as_string_debug(&self) -> String

Returns the equivalent UTF-8 string, useful for debugging.

Trait Implementations

impl Clone for UChar

fn clone(&self) -> UChar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UChar

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

Formats the value using the given formatter.

impl From<Vec<u16>> for UChar

fn from(rep: Vec<UChar>) -> UChar

Adopts a vector of sys::UChar into a string.

impl TryFrom<&UChar> for String

fn try_from(u: &UChar) -> Result<String, Self::Error>

Tries to produce a UTF-8 encoded rust string from a UChar.

This conversion ignores warnings and only reports actual ICU errors when they happen.

Implements u_strToUTF8.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<&str> for UChar

fn try_from(rust_string: &str) -> Result<Self, Self::Error>

Tries to produce a string from the UTF-8 encoded thing.

This conversion ignores warnings (e.g. warnings about unterminated buffers), since for rust they are not relevant.

Implements u_strFromUTF8.

type Error = Error

The type returned in the event of a conversion error.