AttributedSubstring

struct · iOS 15.0+ · SDK 27.1

@dynamicMemberLookup struct AttributedSubstring

A portion of an attributed string. ``AttributedSubstring`` provides no-copy access to the contents of the string within the relevant range. The distinction between an ``AttributedString`` and an ``AttributedSubstring`` lets you distinguish between whether you're in possession of an entire string or just a slice of it. Because ``AttributedSubstring`` and ``AttributedString`` both conform to ``AttributedStringProtocol``, working with ranges of ``AttributedString`` is natural. Modifying attributes by range works the same as it does on the base string. If you use an ``AttributedSubstring`` to mutate its base ``AttributedString``, you must perform your mutation inline, as the following example shows: ```swift // Correct use of copying. attrStr[range].link = url // Incorrect use of AttributedString copy. Copies the referenced range of the base // AttributedString and mutates that. var substr = attrStr[range] substr.link = url ```

Members (13)

get characters(): AttributedString_CharacterView

var characters: AttributedString.CharacterView { get }

get startIndex(): AttributedString_Index

var startIndex: AttributedString.Index { get }

get description(): string

var description: String { get }

setAttributes(attributes: AttributeContainer): void

mutating func setAttributes(_ attributes: AttributeContainer)

get unicodeScalars(): AttributedString_UnicodeScalarView

var unicodeScalars: AttributedString.UnicodeScalarView { get }

mergeAttributes(attributes: AttributeContainer, mergePolicy?: AttributedString_AttributeMergePolicy): void

mutating func mergeAttributes(_ attributes: AttributeContainer, mergePolicy: AttributedString.AttributeMergePolicy = .keepNew)

replaceAttributes(attributes: AttributeContainer, others: AttributeContainer): void

mutating func replaceAttributes(_ attributes: AttributeContainer, with others: AttributeContainer)

get base(): AttributedString

var base: AttributedString { get }

get runs(): AttributedString_Runs

var runs: AttributedString.Runs { get }

get utf8(): AttributedString_UTF8View

var utf8: AttributedString.UTF8View { get }

get utf16(): AttributedString_UTF16View

var utf16: AttributedString.UTF16View { get }

get endIndex(): AttributedString_Index

var endIndex: AttributedString.Index { get }

static init(): AttributedSubstring

init()

All Foundation types →