Struct NSAttributedString

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

Available on crate feature NSAttributedString only.

Apple’s documentation

Implementations

impl NSAttributedString

pub unsafe fn new_with_attributes( string: &NSString, attributes: &NSDictionary<NSAttributedStringKey, AnyObject>, ) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

Creates a new attributed string from the given string and attributes.

The attributes are associated with every UTF-16 code unit in the string.

Safety

The attributes must be valid.

pub fn from_nsstring(string: &NSString) -> Retained<Self>

Available on crate feature NSString only.

Creates a new attributed string without any attributes.

impl NSAttributedString

pub fn string(&self) -> Retained<NSString>

Available on crate feature NSString only.

pub unsafe fn attributesAtIndex_effectiveRange( &self, location: NSUInteger, range: NSRangePointer, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Available on crate features NSDictionary and NSRange and NSString only.

impl NSAttributedString

Methods declared on superclass NSObject.

pub fn init(this: Allocated<Self>) -> Retained<Self>

pub fn new() -> Retained<Self>

impl NSAttributedString

NSExtendedAttributedString.

pub fn length(&self) -> NSUInteger

pub unsafe fn attribute_atIndex_effectiveRange( &self, attr_name: &NSAttributedStringKey, location: NSUInteger, range: NSRangePointer, ) -> Option<Retained<AnyObject>>

Available on crate features NSRange and NSString only.

pub unsafe fn attributedSubstringFromRange( &self, range: NSRange, ) -> Retained<NSAttributedString>

Available on crate feature NSRange only.

pub unsafe fn attributesAtIndex_longestEffectiveRange_inRange( &self, location: NSUInteger, range: NSRangePointer, range_limit: NSRange, ) -> Retained<NSDictionary<NSAttributedStringKey, AnyObject>>

Available on crate features NSDictionary and NSRange and NSString only.

pub unsafe fn attribute_atIndex_longestEffectiveRange_inRange( &self, attr_name: &NSAttributedStringKey, location: NSUInteger, range: NSRangePointer, range_limit: NSRange, ) -> Option<Retained<AnyObject>>

Available on crate features NSRange and NSString only.

pub unsafe fn isEqualToAttributedString( &self, other: &NSAttributedString, ) -> bool

pub fn initWithString(this: Allocated<Self>, str: &NSString) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn initWithString_attributes( this: Allocated<Self>, str: &NSString, attrs: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, ) -> Retained<Self>

Available on crate features NSDictionary and NSString only.

pub fn initWithAttributedString( this: Allocated<Self>, attr_str: &NSAttributedString, ) -> Retained<Self>

pub unsafe fn enumerateAttributesInRange_options_usingBlock( &self, enumeration_range: NSRange, opts: NSAttributedStringEnumerationOptions, block: &DynBlock<dyn Fn(NonNull<NSDictionary<NSAttributedStringKey, AnyObject>>, NSRange, NonNull<Bool>) + '_>, )

Available on crate features NSDictionary and NSRange and NSString and block2 only.

pub unsafe fn enumerateAttribute_inRange_options_usingBlock( &self, attr_name: &NSAttributedStringKey, enumeration_range: NSRange, opts: NSAttributedStringEnumerationOptions, block: &DynBlock<dyn Fn(*mut AnyObject, NSRange, NonNull<Bool>) + '_>, )

Available on crate features NSRange and NSString and block2 only.

impl NSAttributedString

NSAttributedStringCreateFromMarkdown.

pub unsafe fn initWithContentsOfMarkdownFileAtURL_options_baseURL_error( this: Allocated<Self>, markdown_file: &NSURL, options: Option<&NSAttributedStringMarkdownParsingOptions>, base_url: Option<&NSURL>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSURL only.

pub unsafe fn initWithMarkdown_options_baseURL_error( this: Allocated<Self>, markdown: &NSData, options: Option<&NSAttributedStringMarkdownParsingOptions>, base_url: Option<&NSURL>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSData and NSError and NSURL only.

pub unsafe fn initWithMarkdownString_options_baseURL_error( this: Allocated<Self>, markdown_string: &NSString, options: Option<&NSAttributedStringMarkdownParsingOptions>, base_url: Option<&NSURL>, ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSError and NSString and NSURL only.

impl NSAttributedString

NSAttributedStringFormatting.

This impl block contains no items.

impl NSAttributedString

NSMorphology.

pub unsafe fn attributedStringByInflectingString( &self, ) -> Retained<NSAttributedString>

If the string has portions tagged with NSInflectionRuleAttributeName that have no format specifiers, create a new string with those portions inflected by following the rule in the attribute.

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

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

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

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

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for NSAttributedString

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSAttributedString> for NSAttributedString

fn as_ref(&self) -> &Self

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

impl AsRef<NSAttributedString> for NSMutableAttributedString

fn as_ref(&self) -> &NSAttributedString

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

impl AsRef<NSObject> for NSAttributedString

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSAttributedString

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSAttributedString> for NSMutableAttributedString

fn borrow(&self) -> &NSAttributedString

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSAttributedString

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSAttributedString

const NAME: &'static str = "NSAttributedString"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<NSAttributedString as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

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.

impl CopyingHelper for NSAttributedString

Available on crate feature NSObject only.

type Result = NSAttributedString

The immutable counterpart of the type, or Self if the type has no immutable counterpart.

impl Debug for NSAttributedString

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

Formats the value using the given formatter.

impl DefaultRetained for NSAttributedString

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSAttributedString

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSAttributedString

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 Message for NSAttributedString

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl MutableCopyingHelper for NSAttributedString

Available on crate feature NSObject only.

type Result = NSMutableAttributedString

The mutable counterpart of the type, or Self if the type has no mutable counterpart.

impl NSCoding for NSAttributedString

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

impl NSCopying for NSAttributedString

fn copy(&self) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Result>

where Self: Sized + Message + CopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a copy of the receiver.

impl NSMutableCopying for NSAttributedString

fn mutableCopy(&self) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a mutable copy of the receiver.

unsafe fn mutableCopyWithZone( &self, zone: *mut NSZone, ) -> Retained<Self::Result>

where Self: Sized + Message + MutableCopyingHelper,

Available on crate feature NSObject only.

Returns a new instance that’s a mutable copy of the receiver.

impl NSObjectProtocol for NSAttributedString

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl NSSecureCoding for NSAttributedString

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSAttributedString

fn eq(&self, other: &Self) -> 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 RefEncode for NSAttributedString

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

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

impl ToOwned for NSAttributedString

Available on crate feature NSObject only.

type Owned = Retained<NSAttributedString>

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 DowncastTarget for NSAttributedString

impl Eq for NSAttributedString

impl RefUnwindSafe for NSAttributedString

impl UnwindSafe for NSAttributedString