Struct NSCalendar

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

Available on crate feature NSCalendar only.

Apple’s documentation

Implementations

impl NSCalendar

pub unsafe fn currentCalendar() -> Retained<NSCalendar>

pub unsafe fn autoupdatingCurrentCalendar() -> Retained<NSCalendar>

pub unsafe fn calendarWithIdentifier( calendar_identifier_constant: &NSCalendarIdentifier, ) -> Option<Retained<NSCalendar>>

Available on crate feature NSString only.

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

pub unsafe fn initWithCalendarIdentifier( this: Allocated<Self>, ident: &NSCalendarIdentifier, ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn calendarIdentifier(&self) -> Retained<NSCalendarIdentifier>

Available on crate feature NSString only.

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

Available on crate feature NSLocale only.

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

Available on crate feature NSLocale only.

Setter for locale.

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

Available on crate feature NSTimeZone only.

pub unsafe fn setTimeZone(&self, time_zone: &NSTimeZone)

Available on crate feature NSTimeZone only.

Setter for timeZone.

pub unsafe fn firstWeekday(&self) -> NSUInteger

pub unsafe fn setFirstWeekday(&self, first_weekday: NSUInteger)

Setter for firstWeekday.

pub unsafe fn minimumDaysInFirstWeek(&self) -> NSUInteger

pub unsafe fn setMinimumDaysInFirstWeek( &self, minimum_days_in_first_week: NSUInteger, )

Setter for minimumDaysInFirstWeek.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn minimumRangeOfUnit(&self, unit: NSCalendarUnit) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn maximumRangeOfUnit(&self, unit: NSCalendarUnit) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfUnit_inUnit_forDate( &self, smaller: NSCalendarUnit, larger: NSCalendarUnit, date: &NSDate, ) -> NSRange

Available on crate features NSDate and NSRange only.

pub unsafe fn ordinalityOfUnit_inUnit_forDate( &self, smaller: NSCalendarUnit, larger: NSCalendarUnit, date: &NSDate, ) -> NSUInteger

Available on crate feature NSDate only.

pub unsafe fn rangeOfUnit_startDate_interval_forDate( &self, unit: NSCalendarUnit, datep: Option<&mut Option<Retained<NSDate>>>, tip: *mut NSTimeInterval, date: &NSDate, ) -> bool

Available on crate feature NSDate only.

pub unsafe fn dateFromComponents( &self, comps: &NSDateComponents, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn components_fromDate( &self, unit_flags: NSCalendarUnit, date: &NSDate, ) -> Retained<NSDateComponents>

Available on crate feature NSDate only.

pub unsafe fn dateByAddingComponents_toDate_options( &self, comps: &NSDateComponents, date: &NSDate, opts: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn components_fromDate_toDate_options( &self, unit_flags: NSCalendarUnit, starting_date: &NSDate, result_date: &NSDate, opts: NSCalendarOptions, ) -> Retained<NSDateComponents>

Available on crate feature NSDate only.

pub unsafe fn getEra_year_month_day_fromDate( &self, era_value_pointer: *mut NSInteger, year_value_pointer: *mut NSInteger, month_value_pointer: *mut NSInteger, day_value_pointer: *mut NSInteger, date: &NSDate, )

Available on crate feature NSDate only.

pub unsafe fn getEra_yearForWeekOfYear_weekOfYear_weekday_fromDate( &self, era_value_pointer: *mut NSInteger, year_value_pointer: *mut NSInteger, week_value_pointer: *mut NSInteger, weekday_value_pointer: *mut NSInteger, date: &NSDate, )

Available on crate feature NSDate only.

pub unsafe fn getHour_minute_second_nanosecond_fromDate( &self, hour_value_pointer: *mut NSInteger, minute_value_pointer: *mut NSInteger, second_value_pointer: *mut NSInteger, nanosecond_value_pointer: *mut NSInteger, date: &NSDate, )

Available on crate feature NSDate only.

pub unsafe fn component_fromDate( &self, unit: NSCalendarUnit, date: &NSDate, ) -> NSInteger

Available on crate feature NSDate only.

pub unsafe fn dateWithEra_year_month_day_hour_minute_second_nanosecond( &self, era_value: NSInteger, year_value: NSInteger, month_value: NSInteger, day_value: NSInteger, hour_value: NSInteger, minute_value: NSInteger, second_value: NSInteger, nanosecond_value: NSInteger, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn dateWithEra_yearForWeekOfYear_weekOfYear_weekday_hour_minute_second_nanosecond( &self, era_value: NSInteger, year_value: NSInteger, week_value: NSInteger, weekday_value: NSInteger, hour_value: NSInteger, minute_value: NSInteger, second_value: NSInteger, nanosecond_value: NSInteger, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn startOfDayForDate(&self, date: &NSDate) -> Retained<NSDate>

Available on crate feature NSDate only.

pub unsafe fn componentsInTimeZone_fromDate( &self, timezone: &NSTimeZone, date: &NSDate, ) -> Retained<NSDateComponents>

Available on crate features NSDate and NSTimeZone only.

pub unsafe fn compareDate_toDate_toUnitGranularity( &self, date1: &NSDate, date2: &NSDate, unit: NSCalendarUnit, ) -> NSComparisonResult

Available on crate features NSDate and NSObjCRuntime only.

pub unsafe fn isDate_equalToDate_toUnitGranularity( &self, date1: &NSDate, date2: &NSDate, unit: NSCalendarUnit, ) -> bool

Available on crate feature NSDate only.

pub unsafe fn isDate_inSameDayAsDate( &self, date1: &NSDate, date2: &NSDate, ) -> bool

Available on crate feature NSDate only.

pub unsafe fn isDateInToday(&self, date: &NSDate) -> bool

Available on crate feature NSDate only.

pub unsafe fn isDateInYesterday(&self, date: &NSDate) -> bool

Available on crate feature NSDate only.

pub unsafe fn isDateInTomorrow(&self, date: &NSDate) -> bool

Available on crate feature NSDate only.

pub unsafe fn isDateInWeekend(&self, date: &NSDate) -> bool

Available on crate feature NSDate only.

pub unsafe fn rangeOfWeekendStartDate_interval_containingDate( &self, datep: Option<&mut Option<Retained<NSDate>>>, tip: *mut NSTimeInterval, date: &NSDate, ) -> bool

Available on crate feature NSDate only.

pub unsafe fn nextWeekendStartDate_interval_options_afterDate( &self, datep: Option<&mut Option<Retained<NSDate>>>, tip: *mut NSTimeInterval, options: NSCalendarOptions, date: &NSDate, ) -> bool

Available on crate feature NSDate only.

pub unsafe fn components_fromDateComponents_toDateComponents_options( &self, unit_flags: NSCalendarUnit, starting_date_comp: &NSDateComponents, result_date_comp: &NSDateComponents, options: NSCalendarOptions, ) -> Retained<NSDateComponents>

pub unsafe fn dateByAddingUnit_value_toDate_options( &self, unit: NSCalendarUnit, value: NSInteger, date: &NSDate, options: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn enumerateDatesStartingAfterDate_matchingComponents_options_usingBlock( &self, start: &NSDate, comps: &NSDateComponents, opts: NSCalendarOptions, block: &DynBlock<dyn Fn(*mut NSDate, Bool, NonNull<Bool>) + '_>, )

Available on crate features NSDate and block2 only.

pub unsafe fn nextDateAfterDate_matchingComponents_options( &self, date: &NSDate, comps: &NSDateComponents, options: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn nextDateAfterDate_matchingUnit_value_options( &self, date: &NSDate, unit: NSCalendarUnit, value: NSInteger, options: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn nextDateAfterDate_matchingHour_minute_second_options( &self, date: &NSDate, hour_value: NSInteger, minute_value: NSInteger, second_value: NSInteger, options: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn dateBySettingUnit_value_ofDate_options( &self, unit: NSCalendarUnit, v: NSInteger, date: &NSDate, opts: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn dateBySettingHour_minute_second_ofDate_options( &self, h: NSInteger, m: NSInteger, s: NSInteger, date: &NSDate, opts: NSCalendarOptions, ) -> Option<Retained<NSDate>>

Available on crate feature NSDate only.

pub unsafe fn date_matchesComponents( &self, date: &NSDate, components: &NSDateComponents, ) -> bool

Available on crate feature NSDate only.

impl NSCalendar

Methods declared on superclass NSObject.

pub unsafe fn new() -> Retained<Self>

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 NSCalendar

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSCalendar> for NSCalendar

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NSCalendar

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NSCalendar

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSCalendar

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSCalendar

const NAME: &'static str = "NSCalendar"

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

type Super = NSObject

The superclass of this class.

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

Available on crate feature NSObject only.

type Result = NSCalendar

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

impl Debug for NSCalendar

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

Formats the value using the given formatter.

impl Deref for NSCalendar

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSCalendar

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 NSCalendar

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for NSCalendar

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 NSCalendar

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 NSCalendar

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 NSCalendar

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

Available on crate feature NSObject only.

impl PartialEq for NSCalendar

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 NSCalendar

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

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

impl DowncastTarget for NSCalendar

impl Eq for NSCalendar