Struct objc2_foundation::NSAttributedString

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

A string that has associated attributes for portions of its text.

Examples of attributes could be: Visual style, hyperlinks, or accessibility data.

Conceptually, each UTF-16 code unit in an attributed string has its own collection of attributes - most often though

Only the most basic functionality is defined here, the AppKit framework contains most of the extension methods.

See Apple’s documentation.

Implementations

impl NSAttributedString

pub fn class() -> &'static Class

impl NSAttributedString

Creating attributed strings.

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

Construct an empty attributed string.

pub fn new_with_attributes(
    string: &NSString,
    attributes: &NSDictionary<NSAttributedStringKey, Object>
) -> Id<Self, Shared>

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

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

pub fn from_nsstring(string: &NSString) -> Id<Self, Shared>

Creates a new attributed string without any attributes.

impl NSAttributedString

Querying.

pub fn string(&self) -> &NSString

Methods from Deref<Target = NSObject>

pub fn hash_code(&self) -> usize

pub fn is_equal(&self, other: &NSObject) -> bool

pub fn description(&self) -> Id<NSString, Shared>

pub fn is_kind_of(&self, cls: &Class) -> bool

Methods from Deref<Target = Object>

pub fn class(&self) -> &Class

Dynamically find the class of this object.

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

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

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

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

👎 Deprecated:

Use Object::ivar instead.

Use ivar instead.

Safety

Same as ivar.

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

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

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

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

👎 Deprecated:

Use Object::ivar_mut instead.

Use ivar_mut instead.

Safety

Same as ivar_mut.

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

Sets the value of the ivar with the given name.

Panics

Panics if the object has no ivar with the given name, or the type encoding of the ivar differs from the type encoding of T.

Safety

The caller must ensure that the ivar is actually of type T.

Library implementors should expose a safe interface to the ivar.

Trait Implementations

impl AsMut<NSAttributedString> for NSAttributedString

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

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

impl AsMut<NSAttributedString> for NSMutableAttributedString

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

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

impl AsMut<NSObject> for NSAttributedString

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

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

impl AsMut<Object> for NSAttributedString

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

Converts this type into a mutable 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 AsRef<Object> for NSAttributedString

fn as_ref(&self) -> &Object

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

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 Borrow<Object> for NSAttributedString

fn borrow(&self) -> &Object

Immutably borrows from an owned value.

impl BorrowMut<NSAttributedString> for NSMutableAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSAttributedString

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

Mutably borrows from an owned value.

impl BorrowMut<Object> for NSAttributedString

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

Mutably borrows from an owned value.

impl Debug for NSAttributedString

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

Formats the value using the given formatter.

impl DefaultId for NSAttributedString

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 NSAttributedString

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSAttributedString

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

Mutably 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, 

Feeds a slice of this type into the given Hasher.

impl NSCopying for NSAttributedString

type Ownership = Shared

Indicates whether the type is mutable or immutable.

type Output = NSAttributedString

The output type.

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

impl NSMutableCopying for NSAttributedString

type Output = NSMutableAttributedString

TODO

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

impl PartialEq<NSAttributedString> for NSAttributedString

fn eq(&self, other: &Self) -> 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 !=.

impl RefEncode for NSAttributedString

const ENCODING_REF: Encoding<'static> = ::objc2::Encoding::Object

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

impl ToOwned for NSAttributedString

type Owned = Id<NSAttributedString, 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 NSAttributedString

impl Message for NSAttributedString

impl Send for NSAttributedString

impl Sync for NSAttributedString