Struct NSDateFormatter 

pub struct NSDateFormatter { /* private fields */ }

Available on crate features NSDateFormatter and NSFormatter only.

Apple’s documentation

Implementations

impl NSDateFormatter

pub fn formattingContext(&self) -> NSFormattingContext

pub fn setFormattingContext(&self, formatting_context: NSFormattingContext)

Setter for formattingContext.

pub unsafe fn getObjectValue_forString_range_error( &self, obj: Option<&mut Option<Retained<AnyObject>>>, string: &NSString, rangep: *mut NSRange, ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSRange and NSString only.

Safety

• obj should be of the correct type.
• rangep must be a valid pointer or null.

pub fn stringFromDate(&self, date: &NSDate) -> Retained<NSString>

Available on crate features NSDate and NSString only.

pub fn dateFromString(&self, string: &NSString) -> Option<Retained<NSDate>>

Available on crate features NSDate and NSString only.

pub fn localizedStringFromDate_dateStyle_timeStyle( date: &NSDate, dstyle: NSDateFormatterStyle, tstyle: NSDateFormatterStyle, ) -> Retained<NSString>

Available on crate features NSDate and NSString only.

pub fn dateFormatFromTemplate_options_locale( tmplate: &NSString, opts: NSUInteger, locale: Option<&NSLocale>, ) -> Option<Retained<NSString>>

Available on crate features NSLocale and NSString only.

pub fn defaultFormatterBehavior() -> NSDateFormatterBehavior

pub fn setDefaultFormatterBehavior( default_formatter_behavior: NSDateFormatterBehavior, )

Setter for defaultFormatterBehavior.

pub fn setLocalizedDateFormatFromTemplate( &self, date_format_template: &NSString, )

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub fn setDateFormat(&self, date_format: Option<&NSString>)

Available on crate feature NSString only.

Setter for dateFormat.

This is copied when set.

pub fn dateStyle(&self) -> NSDateFormatterStyle

pub fn setDateStyle(&self, date_style: NSDateFormatterStyle)

Setter for dateStyle.

pub fn timeStyle(&self) -> NSDateFormatterStyle

pub fn setTimeStyle(&self, time_style: NSDateFormatterStyle)

Setter for timeStyle.

pub fn locale(&self) -> Retained<NSLocale>

Available on crate feature NSLocale only.

pub fn setLocale(&self, locale: Option<&NSLocale>)

Available on crate feature NSLocale only.

Setter for locale.

This is copied when set.

pub fn generatesCalendarDates(&self) -> bool

pub fn setGeneratesCalendarDates(&self, generates_calendar_dates: bool)

Setter for generatesCalendarDates.

pub fn formatterBehavior(&self) -> NSDateFormatterBehavior

pub fn setFormatterBehavior(&self, formatter_behavior: NSDateFormatterBehavior)

Setter for formatterBehavior.

pub fn timeZone(&self) -> Retained<NSTimeZone>

Available on crate feature NSTimeZone only.

pub fn setTimeZone(&self, time_zone: Option<&NSTimeZone>)

Available on crate feature NSTimeZone only.

Setter for timeZone.

This is copied when set.

pub fn calendar(&self) -> Retained<NSCalendar>

Available on crate feature NSCalendar only.

pub fn setCalendar(&self, calendar: Option<&NSCalendar>)

Available on crate feature NSCalendar only.

Setter for calendar.

This is copied when set.

pub fn isLenient(&self) -> bool

pub fn setLenient(&self, lenient: bool)

Setter for isLenient.

pub fn twoDigitStartDate(&self) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub fn setTwoDigitStartDate(&self, two_digit_start_date: Option<&NSDate>)

Available on crate feature NSDate only.

Setter for twoDigitStartDate.

This is copied when set.

pub fn defaultDate(&self) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub fn setDefaultDate(&self, default_date: Option<&NSDate>)

Available on crate feature NSDate only.

Setter for defaultDate.

This is copied when set.

pub fn eraSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setEraSymbols(&self, era_symbols: Option<&NSArray<NSString>>)

Available on crate features NSArray and NSString only.

Setter for eraSymbols.

This is copied when set.

pub fn monthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setMonthSymbols(&self, month_symbols: Option<&NSArray<NSString>>)

Available on crate features NSArray and NSString only.

Setter for monthSymbols.

This is copied when set.

pub fn shortMonthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortMonthSymbols( &self, short_month_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortMonthSymbols.

This is copied when set.

pub fn weekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setWeekdaySymbols(&self, weekday_symbols: Option<&NSArray<NSString>>)

Available on crate features NSArray and NSString only.

Setter for weekdaySymbols.

This is copied when set.

pub fn shortWeekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortWeekdaySymbols( &self, short_weekday_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortWeekdaySymbols.

This is copied when set.

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

Available on crate feature NSString only.

pub fn setAMSymbol(&self, am_symbol: Option<&NSString>)

Available on crate feature NSString only.

Setter for AMSymbol.

This is copied when set.

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

Available on crate feature NSString only.

pub fn setPMSymbol(&self, pm_symbol: Option<&NSString>)

Available on crate feature NSString only.

Setter for PMSymbol.

This is copied when set.

pub fn longEraSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setLongEraSymbols(&self, long_era_symbols: Option<&NSArray<NSString>>)

Available on crate features NSArray and NSString only.

Setter for longEraSymbols.

This is copied when set.

pub fn veryShortMonthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setVeryShortMonthSymbols( &self, very_short_month_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for veryShortMonthSymbols.

This is copied when set.

pub fn standaloneMonthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setStandaloneMonthSymbols( &self, standalone_month_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for standaloneMonthSymbols.

This is copied when set.

pub fn shortStandaloneMonthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortStandaloneMonthSymbols( &self, short_standalone_month_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortStandaloneMonthSymbols.

This is copied when set.

pub fn veryShortStandaloneMonthSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setVeryShortStandaloneMonthSymbols( &self, very_short_standalone_month_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for veryShortStandaloneMonthSymbols.

This is copied when set.

pub fn veryShortWeekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setVeryShortWeekdaySymbols( &self, very_short_weekday_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for veryShortWeekdaySymbols.

This is copied when set.

pub fn standaloneWeekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setStandaloneWeekdaySymbols( &self, standalone_weekday_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for standaloneWeekdaySymbols.

This is copied when set.

pub fn shortStandaloneWeekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortStandaloneWeekdaySymbols( &self, short_standalone_weekday_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortStandaloneWeekdaySymbols.

This is copied when set.

pub fn veryShortStandaloneWeekdaySymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setVeryShortStandaloneWeekdaySymbols( &self, very_short_standalone_weekday_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for veryShortStandaloneWeekdaySymbols.

This is copied when set.

pub fn quarterSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setQuarterSymbols(&self, quarter_symbols: Option<&NSArray<NSString>>)

Available on crate features NSArray and NSString only.

Setter for quarterSymbols.

This is copied when set.

pub fn shortQuarterSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortQuarterSymbols( &self, short_quarter_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortQuarterSymbols.

This is copied when set.

pub fn standaloneQuarterSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setStandaloneQuarterSymbols( &self, standalone_quarter_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for standaloneQuarterSymbols.

This is copied when set.

pub fn shortStandaloneQuarterSymbols(&self) -> Retained<NSArray<NSString>>

Available on crate features NSArray and NSString only.

pub fn setShortStandaloneQuarterSymbols( &self, short_standalone_quarter_symbols: Option<&NSArray<NSString>>, )

Available on crate features NSArray and NSString only.

Setter for shortStandaloneQuarterSymbols.

This is copied when set.

pub fn gregorianStartDate(&self) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub fn setGregorianStartDate(&self, gregorian_start_date: Option<&NSDate>)

Available on crate feature NSDate only.

Setter for gregorianStartDate.

This is copied when set.

pub fn doesRelativeDateFormatting(&self) -> bool

pub fn setDoesRelativeDateFormatting(&self, does_relative_date_formatting: bool)

Setter for doesRelativeDateFormatting.

impl NSDateFormatter

Methods declared on superclass NSObject.

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

pub fn new() -> Retained<Self>

impl NSDateFormatter

NSDateFormatterCompatibility.

pub fn initWithDateFormat_allowNaturalLanguage( this: Allocated<Self>, format: &NSString, flag: bool, ) -> Retained<Self>

👎Deprecated: Create an NSDateFormatter with init and set the dateFormat property instead.

Available on crate feature NSString only.

pub fn allowsNaturalLanguage(&self) -> bool

👎Deprecated: There is no replacement

Methods from Deref<Target = NSFormatter>

pub unsafe fn stringForObjectValue( &self, obj: Option<&AnyObject>, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Safety

obj should be of the correct type.

pub unsafe fn attributedStringForObjectValue_withDefaultAttributes( &self, obj: &AnyObject, attrs: Option<&NSDictionary<NSAttributedStringKey, AnyObject>>, ) -> Option<Retained<NSAttributedString>>

Available on crate features NSAttributedString and NSDictionary and NSString only.

Safety

• obj should be of the correct type.
• attrs generic should be of the correct type.

pub unsafe fn editingStringForObjectValue( &self, obj: &AnyObject, ) -> Option<Retained<NSString>>

Available on crate feature NSString only.

Safety

obj should be of the correct type.

pub unsafe fn getObjectValue_forString_errorDescription( &self, obj: Option<&mut Option<Retained<AnyObject>>>, string: &NSString, error: Option<&mut Option<Retained<NSString>>>, ) -> bool

Available on crate feature NSString only.

Safety

obj should be of the correct type.

pub fn isPartialStringValid_newEditingString_errorDescription( &self, partial_string: &NSString, new_string: Option<&mut Option<Retained<NSString>>>, error: Option<&mut Option<Retained<NSString>>>, ) -> bool

Available on crate feature NSString only.

pub unsafe fn isPartialStringValid_proposedSelectedRange_originalString_originalSelectedRange_errorDescription( &self, partial_string_ptr: &mut Retained<NSString>, proposed_sel_range_ptr: NSRangePointer, orig_string: &NSString, orig_sel_range: NSRange, error: Option<&mut Option<Retained<NSString>>>, ) -> bool

Available on crate features NSRange and NSString only.

Safety

proposed_sel_range_ptr must be a valid pointer or null.

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 NSDateFormatter

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSDateFormatter> for NSDateFormatter

fn as_ref(&self) -> &Self

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

impl AsRef<NSFormatter> for NSDateFormatter

fn as_ref(&self) -> &NSFormatter

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

impl AsRef<NSObject> for NSDateFormatter

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSDateFormatter

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSFormatter> for NSDateFormatter

fn borrow(&self) -> &NSFormatter

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSDateFormatter

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSDateFormatter

const NAME: &'static str = "NSDateFormatter"

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

type Super = NSFormatter

The superclass of this class.

type ThreadKind = <<NSDateFormatter 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 NSDateFormatter

Available on crate feature NSObject only.

type Result = NSDateFormatter

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

impl Debug for NSDateFormatter

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

Formats the value using the given formatter.

impl DefaultRetained for NSDateFormatter

fn default_retained() -> Retained<Self>

The default Retained for a type.

impl Deref for NSDateFormatter

type Target = NSFormatter

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSDateFormatter

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 NSDateFormatter

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSDateFormatter

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

Safety

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

where Self: Sized + Message,

Available on crate features NSObject and NSCoder only.

Safety

impl NSCopying for NSDateFormatter

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 NSObjectProtocol for NSDateFormatter

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 PartialEq for NSDateFormatter

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 NSDateFormatter

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

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

impl DowncastTarget for NSDateFormatter

impl Eq for NSDateFormatter

impl Send for NSDateFormatter

impl Sync for NSDateFormatter