Struct String 

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

An Objective-C string object.

C++ equivalent: NS::String

Implementations

impl String

pub fn string() -> Option<Self>

Create an empty string.

C++ equivalent: static String* string()

pub fn string_with_string(string: &String) -> Option<Self>

Create a string from another string.

C++ equivalent: static String* string(const String* pString)

pub fn string_with_cstring( cstring: *const c_char, encoding: StringEncoding, ) -> Option<Self>

Create a string from a C string with the specified encoding.

C++ equivalent: static String* string(const char* pString, StringEncoding encoding)

pub fn alloc() -> Option<Self>

Allocate a new string.

C++ equivalent: static String* alloc()

pub fn init(&self) -> Option<Self>

Initialize an allocated string.

C++ equivalent: String* init()

pub fn init_with_string(&self, string: &String) -> Option<Self>

Initialize with another string.

C++ equivalent: String* init(const String* pString)

pub fn init_with_cstring( &self, cstring: *const c_char, encoding: StringEncoding, ) -> Option<Self>

Initialize with a C string and encoding.

C++ equivalent: String* init(const char* pString, StringEncoding encoding)

pub fn init_with_bytes_no_copy( &self, bytes: *mut c_void, len: UInteger, encoding: StringEncoding, free_when_done: bool, ) -> Option<Self>

Initialize with bytes, length, encoding, and free buffer flag.

C++ equivalent: String* init(void* pBytes, UInteger len, StringEncoding encoding, bool freeBuffer)

pub fn character(&self, index: UInteger) -> Unichar

Get the character at the specified index.

C++ equivalent: unichar character(UInteger index) const

pub fn length(&self) -> UInteger

Get the length of the string in characters.

C++ equivalent: UInteger length() const

pub fn c_string(&self, encoding: StringEncoding) -> *const c_char

Get the string as a C string with the specified encoding.

C++ equivalent: const char* cString(StringEncoding encoding) const

pub fn utf8_string(&self) -> *const c_char

Get the string as a UTF-8 C string.

C++ equivalent: const char* utf8String() const

pub fn maximum_length_of_bytes(&self, encoding: StringEncoding) -> UInteger

Get the maximum length in bytes for the specified encoding.

C++ equivalent: UInteger maximumLengthOfBytes(StringEncoding encoding) const

pub fn length_of_bytes(&self, encoding: StringEncoding) -> UInteger

Get the actual length in bytes for the specified encoding.

C++ equivalent: UInteger lengthOfBytes(StringEncoding encoding) const

pub fn is_equal_to_string(&self, string: &String) -> bool

Check if this string is equal to another string.

C++ equivalent: bool isEqualToString(const String* pString) const

pub fn range_of_string( &self, string: &String, options: StringCompareOptions, ) -> Range

Find the range of a substring with the specified options.

C++ equivalent: Range rangeOfString(const String* pString, StringCompareOptions options) const

pub fn file_system_representation(&self) -> *const c_char

Get the file system representation of the string.

C++ equivalent: const char* fileSystemRepresentation() const

pub fn string_by_appending_string(&self, string: &String) -> Option<Self>

Create a new string by appending another string.

C++ equivalent: String* stringByAppendingString(const String* pString) const

pub fn case_insensitive_compare(&self, string: &String) -> ComparisonResult

Perform a case-insensitive comparison with another string.

C++ equivalent: ComparisonResult caseInsensitiveCompare(const String* pString) const

pub unsafe fn from_ptr(ptr: *mut c_void) -> Option<Self>

Create a String from a raw pointer.

Safety

The pointer must be a valid Objective-C NSString object.

pub fn from_str(s: &str) -> Option<Self>

Create a string from a Rust &str.

This is a convenience method for Rust users.

pub fn to_string(&self) -> Option<String>

Convert to a Rust String.

This is a convenience method for Rust users.

Trait Implementations

impl Clone for String

fn clone(&self) -> String

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copying for String

fn copy(&self) -> Option<Self>

Create a copy of this object.

impl Debug for String

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

Formats the value using the given formatter.

impl Display for String

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

Formats the value using the given formatter.

impl Referencing for String

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> UInteger

Get the retain count of the object.

impl Send for String

impl Sync for String