Expand description
Access essential data types, collections, and operating-system services to define the base layer of functionality for your app.
Re-exports§
pub use ns_array::NSArray;
Modules§
- macros
- Macros for working with the Foundation framework.
- ns_
array - A type that represents a pointer to an Objective-C object.
- ns_
localekey - The keys used to access components of a locale.
- string
- Enums for String Encoding
Structs§
- NSAttributed
String - A string with associated attributes (such as visual style, hyperlinks, or accessibility data) for portions of its text.
- NSAutorelease
Pool - An object that supports Cocoa’s reference-counted memory management system.
- NSBundle
- A representation of the code and resources stored in a bundle directory on disk.
- NSCharacter
Set - A character set containing the characters in Unicode General Categories L*, M*, and N*.
- NSCoder
- An abstract class that serves as the basis for objects that enable archiving and distribution of other objects.
- NSData
- A static byte buffer in memory.
- NSDate
- A representation of a specific point in time, independent of any calendar or time zone.
- NSDate
Components - An object that specifies a date or time in terms of units (such as year, month, day, hour, and minute) to be evaluated in a calendar system and time zone.
- NSDecimal
Number - An object for representing and performing arithmetic on base-10 numbers.
- NSDecimal
Number Handler - A class that adopts the decimal number behaviors protocol.
- NSDictionary
- A static collection of objects associated with unique keys.
- NSEdge
Insets - A description of the distance between the edges of two rectangles.
- NSEnumerator
- An abstract class whose subclasses enumerate collections of objects, such as arrays and dictionaries.
- NSError
- Information about an error condition including a domain, a domain-specific error code, and application-specific information.
- NSFile
Wrapper - NSFormatter
- An abstract class that declares an interface for objects that create, interpret, and validate the textual representation of values.
- NSIndex
Set - An immutable collection of unique integer values that represent indexes in another collection.
- NSLocale
- The
NSLocaleclass provides information about the user’s locale and formatting preferences. - NSMutable
Array - A dynamic ordered collection of objects.
- NSMutable
Dictionary - A dynamic collection of objects associated with unique keys.
- NSMutable
String - A mutable string.
- NSNotification
- A container for information broadcast through a notification center to all registered observers.
- NSNull
- Returns the singleton instance of NSNull.
- NSNumber
- An object wrapper for primitive scalar numeric values.
- NSNumber
Formatter - A formatter that converts between numeric values and their textual representations.
- NSOperating
System Version - A structure that contains version information about the currently executing operating system, including major, minor, and patch version numbers.
- NSOrthography
- A description of the linguistic content of natural language text, typically used for spelling and grammar checking.
- NSPredicate
- A definition of logical conditions for constraining a search for a fetch or for in-memory filtering.
- NSProcess
Info - A collection of information about the current process.
- NSRange
- A structure used to describe a portion of a series, such as characters in a string or objects in an array.
- NSSet
- A static, unordered collection of unique objects.
- NSSpell
Server - A server that your app uses to provide a spell checker service to other apps running in the system.
- NSString
- This is a mapping to the Objective-C NSString class.
- NSText
Checking Result - NSURL
- An object that represents the location of a resource, such as an item on a remote server or the path to a local file.
- NSUUID
- A universally unique value that can be used to identify types, interfaces, and other items.
Enums§
- Language
Direction - The directions that a language may take across a page of text.
- MachO
Architecture - NSActivity
Options - Option flags used with
begin_activity_with_options_reasonandperform_activity_with_options_reason_using_block. - NSAlignment
Options - NSAttributed
String Enumeration Options - NSByte
Count Formatter Count Style - NSByte
Count Formatter Units - NSCalculation
Error - Calculation error constants used to describe an error in exceptionDuringOperation:error:leftOperand:rightOperand:.
- NSCalendar
Options - NSCalendar
Unit - NSComparison
Predicate Modifier - NSComparison
Predicate Options - NSComparison
Result - Constants that indicate sort order.
- NSCompound
Predicate Type - NSData
Base64 Decoding Options - Options to modify the decoding algorithm used to decode Base64 encoded data.
- NSData
Base64 Encoding Options - Options for methods used to Base64 encode data.
- NSData
Compression Algorithm - An algorithm that indicates how to compress or decompress data.
- NSData
Reading Options - Options for methods used to read data objects.
- NSData
Search Options - Options for method used to search data objects.
- NSData
Writing Options - Options for methods used to write data objects.
- NSDate
Components Formatter Units Style - NSDate
Formatter Behavior - Constants that specify the behavior NSDateFormatter should exhibit.
- NSDate
Formatter Style - NSDate
Interval Formatter Style - NSDecoding
Failure Policy - NSDirectory
Enumeration Options - NSEnergy
Formatter Unit - NSEnumeration
Options - NSExpression
Type - NSFile
Coordinator Reading Options - NSFile
Coordinator Writing Options - NSFile
Manager Item Replacement Options - NSFile
Version Adding Options - NSFile
Version Replacing Options - NSFile
Wrapper Reading Options - NSFile
Wrapper Writing Options - NSFormatting
Context - The formatting context for a formatter.
- NSFormatting
Unit Style - Specifies the width of the unit, determining the textual representation.
- NSHttp
Cookie Accept Policy - NSIso8601
Date Format Options - NSItem
Provider Error Code - NSItem
Provider File Options - NSItem
Provider Representation Visibility - NSJson
Reading Options - NSJson
Writing Options - NSKey
Value Change - NSKey
Value Observing Options - NSKey
Value SetMutation Kind - NSLength
Formatter Unit - NSLigature
Type - NSLinguistic
Tagger Options - NSLinguistic
Tagger Unit - NSLocale
Language Direction - NSMass
Formatter Unit - NSMatching
Flags - NSMatching
Options - NSMeasurement
Formatter Unit Options - NSNet
Service Options - These constants specify options for a network service.
- NSNotification
Coalescing - NSNumber
Formatter Behavior - NSNumber
Formatter PadPosition - These constants are used to specify how numbers should be padded. These constants are used by the paddingPosition property.
- NSNumber
Formatter Rounding Mode - These constants are used to specify how numbers should be rounded. These constants are used by the roundingMode property.
- NSNumber
Formatter Style - NSOperation
Queue Priority - NSPerson
Name Components Formatter Options - NSPerson
Name Components Formatter Style - NSPosting
Style - NSPredicate
Operator Type - NSProcess
Info Thermal State - Values used to indicate the system’s thermal state.
- NSProperty
List Format - These constants are used to specify a property list serialization format.
- NSProperty
List Mutability Options - These constants specify mutability options in property lists.
- NSQuality
OfService - NSRect
Edge - NSRegular
Expression Options - NSRounding
Mode - These constants specify rounding behaviors.
- NSSearch
Path Directory - NSSearch
Path Domain - NSSort
Options - NSStream
Event - NSStream
Status - The type declared for the constants listed in Stream Status Constants.
- NSString
Compare Options - These values represent the options available to many of the string classes’ search and comparison methods.
- NSString
Drawing Options - NSString
Encoding Conversion Options - NSText
Checking Type - NSText
Checking Types - NSTime
Zone Name Style - NSUbiquitous
KeyValue Store Change Reason - NSUrl
Bookmark Creation Options - NSUrl
Bookmark Resolution Options - NSUrl
Error - NSUrl
Error Cancelled Reason - NSUrl
Relationship - NSUrl
Request Cache Policy - The constants used to specify interaction with the cached responses.
- NSUrl
Request Network Service Type - NSUrl
Session Auth Challenge Disposition - NSUrl
Session Delayed Request Disposition - NSUrl
Session Response Disposition - NSUrl
Session Task Metrics Resource Fetch Type - NSUrl
Session Task State - NSVolume
Enumeration Options - NSWriting
Direction - NSXpc
Connection Options
Constants§
- UTF8_
ENCODING - Size of UTF8 encoding
Statics§
- Fullwidth
ToHalfwidth ⚠ - A constant containing the transformation of a string from full-width CJK characters to half-width forms.
- Hiragana
ToKatakana ⚠ - A constant containing the transliteration of a string from Hiragana script to Katakana script.
- Latin
ToArabic ⚠ - LatinToArabic
- Latin
ToCyrillic ⚠ - A constant containing the transliteration of a string from Latin script to Cyrillic script.
- Latin
ToGreek ⚠ - A constant containing the transliteration of a string from Latin script to Greek script.
- Latin
ToHangul ⚠ - A constant containing the transliteration of a string from Latin script to Hangul script.
- Latin
ToHebrew ⚠ - A constant containing the transliteration of a string from Latin script to Hebrew script.
- Latin
ToHiragana ⚠ - A constant containing the transliteration of a string from Latin script to Hiragana script.
- Latin
ToKatakana ⚠ - A constant containing the transliteration of a string from Latin script to Katakana script.
- Latin
ToThai ⚠ - A constant containing the transliteration of a string from Latin script to Thai script.
- Mandarin
ToLatin ⚠ - A constant containing the transliteration of a string from Han script to Latin.
- NSCurrent
Locale ⚠DidChange Notification - A notification that indicates that the user’s locale changed.
- NSEdge
Insets ⚠Zero - A zero initialized
NSEdgeInsets. - NSGrammar
Corrections ⚠ - The value for the
NSGrammarCorrectionskey should be an NSArray of NSStrings representing potential substitutions to correct the problem, but it is expected that this may not be available in all cases. NSGrammarUserDescription or NSGrammarCorrections must be supplied in order for correction guidance to be presented to the user. - NSGrammar
Range ⚠ - The value for the
NSGrammarRangedictionary key should be an NSValue containing an NSRange, a subrange of the sentence range used as the return value, whose location should be an offset from the beginning of the sentence–so, for example, an NSGrammarRange for the first four characters of the overall sentence range should be {0, 4}. If the NSGrammarRange key is not present in the dictionary it is assumed to be equal to the overall sentence range. - NSGrammar
User ⚠Description - The value for the
NSGrammarUserDescriptiondictionary key should be an NSString containing descriptive text about that range, to be presented directly to the user; it is intended that the user description should provide enough information to allow the user to correct the problem. It is recommended that NSGrammarUserDescription be supplied in all cases, however, NSGrammarUserDescription or NSGrammarCorrections must be supplied in order for correction guidance to be presented to the user. - NSProcess
Info ⚠Power State DidChange Notification - Posts when the power state of a device changes.
- NSProcess
Info ⚠Thermal State DidChange Notification - Posts when the thermal state of the system changes.
- NSSPELLSERVER_
PTR - Strip
Combining ⚠Marks - A constant containing the transformation of a string by removing combining marks.
- Strip
Diacritics ⚠ - A constant containing the transformation of a string by removing diacritics.
- ToLatin⚠
- A constant containing the transliteration of a string from any script to Latin script.
- ToUnicode
Name ⚠ - An identifier for a transform that converts characters to Unicode names.
- ToXML
Hex ⚠ - A constant containing the transformation of a string from characters to XML hexadecimal escape codes.
Traits§
- INSAttributed
String - A trait containing all the methods for
NSAttributedString - INSAutorelease
Pool - A trait containing all the methods for
NSAutoreleasePool - INSBundle
- A trait containing all the methods for
NSBundle - INSCharacter
Set - A trait containing all the methods for
NSCharacterSet - INSCoder
- A trait containing all the methods for
NSCoder - INSData
- A trait containing all the methods for
NSData - INSDate
- A trait containing all the methods for
NSDate - INSDecimal
Number - A trait containing all the methods for
NSDecimalNumber - INSDecimal
Number Handler - A trait containing all the methods for
NSDecimalNumberHandler - INSDictionary
- A static collection of objects associated with unique keys.
- INSEnumerator
- An abstract class whose subclasses enumerate collections of objects, such as arrays and dictionaries.
- INSError
- A trait containing all the methods for
NSError - INSFile
Wrapper - A trait containing all the methods for
NSFileWrapper - INSFormatter
- A trait containing all the methods for
NSFormatter - INSIndex
Set - A trait containing all the methods for
NSIndexSet - INSLocale
- A trait containing all the methods for
NSLocale - INSMutable
Dictionary - A dynamic collection of objects associated with unique keys.
- INSMutable
String - A trait containing all the methods for
NSMutableString - INSNotification
- A trait containing all the methods for
NSNotification - INSNull
- A trait containing all the methods for
NSNull - INSNumber
- A trait containing all the methods for
NSNumber - INSNumber
Formatter - A trait containing all the methods for
NSNumberFormatter - INSOrthography
- A trait containing all the methods for
NSOrthography - INSProcess
Info - A trait containing all the methods for
NSProcessInfo - INSSpell
Server - A trait containing all the methods for
NSSpellServer - INSString
- A trait containing all the methods for
NSString - INSURL
- A trait containing all the methods for
NSURL - INSUUID
- A trait containing all the methods for
NSUUID - PNSSpell
Server Delegate - The optional methods implemented by the delegate of a spell server.
Functions§
- NSDecimal
Add ⚠ - Adds two decimal values.
- NSDecimal
Compact ⚠ - Compacts the decimal structure for efficiency.
- NSDecimal
Compare ⚠ - Compares two decimal values.
- NSDecimal
Copy ⚠ - Creating a Decimal from Another Decimal
- NSDecimal
Divide ⚠ - Multiplies two decimal numbers together.
- NSDecimal
Multiply ⚠ - Subtracts one decimal value from another.
- NSDecimal
Multiply ⚠ByPower Of10 - Raises the decimal value to the specified power.
- NSDecimal
Normalize ⚠ - Normalizes the internal format of two decimal numbers to simplify later operations.
- NSDecimal
Power ⚠ - Multiplies a decimal by the specified power of 10.
- NSDecimal
Round ⚠ - Rounds off the decimal value.
- NSDecimal
String ⚠ - Returns a string representation of the decimal value appropriate for the specified locale.
- NSDecimal
Subtract ⚠ - Subtracts one decimal value from another.
- NSEdge
Insets ⚠Equal - Checks if the receiver is equal to the given edge insets.
- NSEdge
Insets ⚠Make - Returns a new edge insets with the given top, left, bottom, and right values.
- NSEqual
Ranges ⚠ - Returns a Boolean value that indicates whether two given ranges are equal.
- NSIntersection
Range ⚠ - Returns the intersection of the specified ranges.
- NSLocation
InRange ⚠ - Returns a Boolean value that indicates whether a specified position is in a given range.
- NSLog⚠
- Respond to problem situations in your interactions with APIs, and fine-tune your app for better debugging.
- NSMake
Range ⚠ - Creates a new NSRange from the specified values.
- NSMax
Range ⚠ - Returns the sum of the location and length of the range.
- NSRange
From ⚠String - Returns a range from a textual representation.
- NSString
From ⚠Range - Returns a string representation of a range.
- NSUnion
Range ⚠ - Returns the union of the specified ranges.
- register_
ns_ spell_ server_ delegate_ class
Type Aliases§
- Double
- A double-precision, floating-point value type.
- Int
- Describes an integer.
- Int8
- Describes an 8-bit signed integer.
- Int16
- Describes a 16-bit signed integer.
- Int32
- Describes a 32-bit signed integer.
- Int64
- Describes a 64-bit signed integer.
- NSAttributed
String Document Attribute Key - Attributes that apply to a document.
- NSAttributed
String Document Reading Option Key - Options for importing documents.
- NSAttributed
String Key - Attributes that you can apply to text in an attributed string.
- NSComparator
- Defines the signature for a block object used for comparison operations.
- NSDecimal
- Type alias for
NSDecimalNumber. - NSError
Domain - NSError
User Info Key - These keys may exist in the user info dictionary.
- NSLocale
Key - The keys used to access components of a locale.
- NSNotification
Name - A structure that defines the name of a notification.
- NSPoint
- A point in a Cartesian coordinate system.
- NSProperty
List Read Options - The only read options supported are described in NSPropertyListMutabilityOptions.
- NSProperty
List Write Options - These constants specify mutability options in property lists.
- NSRange
Pointer - Type indicating a parameter is a pointer to an NSRange structure.
- NSRect
- A rectangle.
- NSSize
- A two-dimensional size.
- NSString
Transform - Constants representing an ICU string transform.
- NSTime
Interval - A number of seconds.
- UInt
- Describes an unsigned integer.
- UInt8
- Describes an 8-bit unsigned integer.
- UInt16
- Describes a 16-bit unsigned integer.
- UInt32
- Describes a 32-bit unsigned integer.
- UInt64
- Describes a 64-bit unsigned integer.
- unichar
- Type for UTF-16 code units.