Struct objc2::foundation::NSString

#[repr(C)]
pub struct NSString { /* private fields */ }

An immutable, plain-text Unicode string object.

Can be created statically using the ns_string! macro.

See Apple’s documentation.

Implementations

impl NSString

pub fn new() -> Id<Self, Shared>

Construct an empty NSString.

pub fn concat(&self, other: &Self) -> Id<Self, Shared>

Create a new string by appending the given string to self.

Example

use objc2::ns_string;
let error_tag = ns_string!("Error: ");
let error_string = ns_string!("premature end of file.");
let error_message = error_tag.concat(error_string);
assert_eq!(&*error_message, ns_string!("Error: premature end of file."));

pub fn join_path(&self, other: &Self) -> Id<Self, Shared>

Create a new string by appending the given string, separated by a path separator.

This is similar to Path::join.

Note that this method only works with file paths (not, for example, string representations of URLs).

Examples

use objc2::ns_string;

let extension = ns_string!("scratch.tiff");
assert_eq!(&*ns_string!("/tmp").join_path(extension), ns_string!("/tmp/scratch.tiff"));
assert_eq!(&*ns_string!("/tmp/").join_path(extension), ns_string!("/tmp/scratch.tiff"));
assert_eq!(&*ns_string!("/").join_path(extension), ns_string!("/scratch.tiff"));
assert_eq!(&*ns_string!("").join_path(extension), ns_string!("scratch.tiff"));

pub fn len(&self) -> usize

The number of UTF-8 code units in self.

pub fn len_utf16(&self) -> usize

The number of UTF-16 code units in the string.

See also NSString::len.

pub fn is_empty(&self) -> bool

pub fn as_str<'r, 's: 'r, 'p: 'r>( &'s self, pool: &'p AutoreleasePool ) -> &'r str

Get the str representation of this.

TODO: Further explain this.

pub fn from_str(string: &str) -> Id<Self, Shared>

Creates an immutable NSString by copying the given string slice.

Prefer using the ns_string! macro when possible.

pub fn has_prefix(&self, prefix: &NSString) -> bool

Whether the given string matches the beginning characters of this string.

See Apple’s documentation.

pub fn has_suffix(&self, suffix: &NSString) -> bool

Whether the given string matches the ending characters of this string.

See Apple’s documentation.

Methods from Deref<Target = NSObject>

pub fn is_kind_of<T: ClassType>(&self) -> bool

Check if the object is an instance of the class, or one of it’s subclasses.

See Apple’s documentation for more details on what you may (and what you may not) do with this information.

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

pub unsafe fn ivar_ptr<T: Encode>(&self, name: &str) -> *mut T

Returns a pointer to the instance variable / ivar with the given name.

This is similar to UnsafeCell::get, see that for more information on what is and isn’t safe to do.

Usually you will have defined the instance variable yourself with ClassBuilder::add_ivar, the type of the ivar T must match the type used in that.

Attempting to access or modify private implementation details of a class that you do no control using this is not supported, and may invoke undefined behaviour.

Library implementors are strongly encouraged to expose a safe interface to the ivar.

Panics

May panic if the object has no ivar with the given name. May also panic if the type encoding of the ivar differs from the type encoding of T.

This should purely seen as help while debugging and is not guaranteed (e.g. it may be disabled when debug_assertions are off).

Safety

The object must have an instance variable with the given name, and it must be of type T. Any invariants that the object have assumed about the value of the instance variable must not be violated.

No thread syncronization is done on accesses to the variable, so you must ensure that any access to the returned pointer do not cause data races, and that Rust’s mutability rules are not otherwise violated.

pub unsafe fn ivar<T: Encode>(&self, name: &str) -> &T

Returns a reference to the instance variable with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

No thread syncronization is done, so you must ensure that no other thread is concurrently mutating the variable. This requirement can be considered upheld if all mutation happens through Object::ivar_mut (since that takes &mut self).

pub unsafe fn get_ivar<T: Encode>(&self, name: &str) -> &T

👎Deprecated: Use Object::ivar instead.

Use Object::ivar instead.

Safety

See Object::ivar.

pub unsafe fn ivar_mut<T: Encode>(&mut self, name: &str) -> &mut T

Returns a mutable reference to the ivar with the given name.

See Object::ivar_ptr for more information, including on when this panics.

Safety

The object must have an instance variable with the given name, and it must be of type T.

This access happens through &mut self, which means we know it to be the only reference, hence you do not need to do any work to ensure that data races do not happen.

pub unsafe fn get_mut_ivar<T: Encode>(&mut self, name: &str) -> &mut T

👎Deprecated: Use Object::ivar_mut instead.

Use Object::ivar_mut instead.

Safety

Same as Object::ivar_mut.

pub unsafe fn set_ivar<T: Encode>(&mut self, name: &str, value: T)

Sets the value of the ivar with the given name.

This is just a helpful shorthand for Object::ivar_mut, see that for more information.

Safety

Same as Object::ivar_mut.

Trait Implementations

impl AddAssign<&NSString> for NSMutableString

fn add_assign(&mut self, other: &NSString)

Performs the += operation.

impl AsMut<NSObject> for NSString

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<NSString> for NSMutableString

fn as_mut(&mut self) -> &mut NSString

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

impl AsMut<NSString> for NSString

fn as_mut(&mut self) -> &mut Self

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

impl AsMut<Object> for NSString

fn as_mut(&mut self) -> &mut Object

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

impl AsRef<NSObject> for NSString

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSString> for NSMutableString

fn as_ref(&self) -> &NSString

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

impl AsRef<NSString> for NSString

fn as_ref(&self) -> &Self

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

impl AsRef<Object> for NSString

fn as_ref(&self) -> &Object

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

impl Borrow<NSObject> for NSString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl Borrow<NSString> for NSMutableString

fn borrow(&self) -> &NSString

Immutably borrows from an owned value.

impl Borrow<Object> for NSString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl BorrowMut<NSObject> for NSString

fn borrow_mut(&mut self) -> &mut NSObject

Mutably borrows from an owned value.

impl BorrowMut<NSString> for NSMutableString

fn borrow_mut(&mut self) -> &mut NSString

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSString

fn borrow_mut(&mut self) -> &mut Object

Mutably borrows from an owned value.

impl ClassType for NSString

type Super = NSObject

The superclass of this class.

const NAME: &'static str = _

The name of the Objective-C class that this type represents.

fn class() -> &'static Class

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

impl Debug for NSString

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

Formats the value using the given formatter.

impl DefaultId for NSString

type Ownership = Shared

Indicates whether the default value is mutable or immutable.

fn default_id() -> Id<Self, Self::Ownership>

The default Id for a type.

impl Deref for NSString

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSString

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Display for NSString

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

Formats the value using the given formatter.

impl Hash for NSString

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 NSCopying for NSString

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSString

The output type.

fn copy(&self) -> Id<Self::Output, Self::Ownership>

impl NSMutableCopying for NSString

type Output = NSMutableString

TODO

fn mutable_copy(&self) -> Id<Self::Output, Owned>

impl Ord for NSString

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NSMutableString> for NSString

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

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

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

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

impl PartialEq<NSString> for NSMutableString

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

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

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

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

impl PartialEq<NSString> for NSString

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

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

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

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

impl PartialOrd<NSMutableString> for NSString

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<NSString> for NSMutableString

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

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

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

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

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

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

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

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

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

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

impl PartialOrd<NSString> for NSString

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

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

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

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

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

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

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

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

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

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

impl RefEncode for NSString

const ENCODING_REF: Encoding = <NSObject as crate::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl ToOwned for NSString

type Owned = Id<NSString, Shared>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

impl Eq for NSString

impl Message for NSString

impl RefUnwindSafe for NSString

impl Send for NSString

impl StructuralEq for NSString

impl StructuralPartialEq for NSString

impl Sync for NSString

impl UnwindSafe for NSString