Struct objc2_foundation::NSURL

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

Available on crate feature NSURL only.

Implementations

impl NSURL

pub unsafe fn initWithScheme_host_path( this: Allocated<Self>, scheme: &NSString, host: Option<&NSString>, path: &NSString ) -> Option<Retained<Self>>

👎Deprecated: Use NSURLComponents instead, which lets you create a valid URL with any valid combination of URL components and subcomponents (not just scheme, host and path), and lets you set components and subcomponents with either percent-encoded or un-percent-encoded strings.

Available on crate feature NSString only.

pub unsafe fn initFileURLWithPath_isDirectory_relativeToURL( this: Allocated<Self>, path: &NSString, is_dir: bool, base_url: Option<&NSURL> ) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn initFileURLWithPath_relativeToURL( this: Allocated<Self>, path: &NSString, base_url: Option<&NSURL> ) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn initFileURLWithPath_isDirectory( this: Allocated<Self>, path: &NSString, is_dir: bool ) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn initFileURLWithPath( this: Allocated<Self>, path: &NSString ) -> Retained<Self>

Available on crate feature NSString only.

pub unsafe fn fileURLWithPath_isDirectory_relativeToURL( path: &NSString, is_dir: bool, base_url: Option<&NSURL> ) -> Retained<NSURL>

Available on crate feature NSString only.

pub unsafe fn fileURLWithPath_relativeToURL( path: &NSString, base_url: Option<&NSURL> ) -> Retained<NSURL>

Available on crate feature NSString only.

pub unsafe fn fileURLWithPath_isDirectory( path: &NSString, is_dir: bool ) -> Retained<NSURL>

Available on crate feature NSString only.

pub unsafe fn fileURLWithPath(path: &NSString) -> Retained<NSURL>

Available on crate feature NSString only.

pub unsafe fn initFileURLWithFileSystemRepresentation_isDirectory_relativeToURL( this: Allocated<Self>, path: NonNull<c_char>, is_dir: bool, base_url: Option<&NSURL> ) -> Retained<Self>

pub unsafe fn fileURLWithFileSystemRepresentation_isDirectory_relativeToURL( path: NonNull<c_char>, is_dir: bool, base_url: Option<&NSURL> ) -> Retained<NSURL>

pub unsafe fn initWithString( this: Allocated<Self>, url_string: &NSString ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn initWithString_relativeToURL( this: Allocated<Self>, url_string: &NSString, base_url: Option<&NSURL> ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn URLWithString(url_string: &NSString) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn URLWithString_relativeToURL( url_string: &NSString, base_url: Option<&NSURL> ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn initWithString_encodingInvalidCharacters( this: Allocated<Self>, url_string: &NSString, encoding_invalid_characters: bool ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn URLWithString_encodingInvalidCharacters( url_string: &NSString, encoding_invalid_characters: bool ) -> Option<Retained<Self>>

Available on crate feature NSString only.

pub unsafe fn initWithDataRepresentation_relativeToURL( this: Allocated<Self>, data: &NSData, base_url: Option<&NSURL> ) -> Retained<Self>

Available on crate feature NSData only.

pub unsafe fn URLWithDataRepresentation_relativeToURL( data: &NSData, base_url: Option<&NSURL> ) -> Retained<NSURL>

Available on crate feature NSData only.

pub unsafe fn initAbsoluteURLWithDataRepresentation_relativeToURL( this: Allocated<Self>, data: &NSData, base_url: Option<&NSURL> ) -> Retained<Self>

Available on crate feature NSData only.

pub unsafe fn absoluteURLWithDataRepresentation_relativeToURL( data: &NSData, base_url: Option<&NSURL> ) -> Retained<NSURL>

Available on crate feature NSData only.

pub unsafe fn dataRepresentation(&self) -> Retained<NSData>

Available on crate feature NSData only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn baseURL(&self) -> Option<Retained<NSURL>>

pub unsafe fn absoluteURL(&self) -> Option<Retained<NSURL>>

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn port(&self) -> Option<Retained<NSNumber>>

Available on crate feature NSValue only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

👎Deprecated: The parameterString method is deprecated. Post deprecation for applications linked with or after the macOS 10.15, and for all iOS, watchOS, and tvOS applications, parameterString will always return nil, and the path method will return the complete path including the semicolon separator and params component if the URL string contains them.

Available on crate feature NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn hasDirectoryPath(&self) -> bool

pub unsafe fn getFileSystemRepresentation_maxLength( &self, buffer: NonNull<c_char>, max_buffer_length: NSUInteger ) -> bool

pub unsafe fn fileSystemRepresentation(&self) -> NonNull<c_char>

pub unsafe fn isFileURL(&self) -> bool

pub unsafe fn standardizedURL(&self) -> Option<Retained<NSURL>>

pub unsafe fn isFileReferenceURL(&self) -> bool

pub unsafe fn fileReferenceURL(&self) -> Option<Retained<NSURL>>

pub unsafe fn filePathURL(&self) -> Option<Retained<NSURL>>

pub unsafe fn getResourceValue_forKey_error( &self, value: &mut Option<Retained<AnyObject>>, key: &NSURLResourceKey ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn resourceValuesForKeys_error( &self, keys: &NSArray<NSURLResourceKey> ) -> Result<Retained<NSDictionary<NSURLResourceKey, AnyObject>>, Retained<NSError>>

Available on crate features NSArray and NSDictionary and NSError and NSString only.

pub unsafe fn setResourceValue_forKey_error( &self, value: Option<&AnyObject>, key: &NSURLResourceKey ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn setResourceValues_error( &self, keyed_values: &NSDictionary<NSURLResourceKey, AnyObject> ) -> Result<(), Retained<NSError>>

Available on crate features NSDictionary and NSError and NSString only.

pub unsafe fn removeCachedResourceValueForKey(&self, key: &NSURLResourceKey)

Available on crate feature NSString only.

pub unsafe fn removeAllCachedResourceValues(&self)

pub unsafe fn setTemporaryResourceValue_forKey( &self, value: Option<&AnyObject>, key: &NSURLResourceKey )

Available on crate feature NSString only.

pub unsafe fn bookmarkDataWithOptions_includingResourceValuesForKeys_relativeToURL_error( &self, options: NSURLBookmarkCreationOptions, keys: Option<&NSArray<NSURLResourceKey>>, relative_url: Option<&NSURL> ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate features NSArray and NSData and NSError and NSString only.

pub unsafe fn initByResolvingBookmarkData_options_relativeToURL_bookmarkDataIsStale_error( this: Allocated<Self>, bookmark_data: &NSData, options: NSURLBookmarkResolutionOptions, relative_url: Option<&NSURL>, is_stale: *mut Bool ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn URLByResolvingBookmarkData_options_relativeToURL_bookmarkDataIsStale_error( bookmark_data: &NSData, options: NSURLBookmarkResolutionOptions, relative_url: Option<&NSURL>, is_stale: *mut Bool ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn resourceValuesForKeys_fromBookmarkData( keys: &NSArray<NSURLResourceKey>, bookmark_data: &NSData ) -> Option<Retained<NSDictionary<NSURLResourceKey, AnyObject>>>

Available on crate features NSArray and NSData and NSDictionary and NSString only.

pub unsafe fn writeBookmarkData_toURL_options_error( bookmark_data: &NSData, bookmark_file_url: &NSURL, options: NSURLBookmarkFileCreationOptions ) -> Result<(), Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn bookmarkDataWithContentsOfURL_error( bookmark_file_url: &NSURL ) -> Result<Retained<NSData>, Retained<NSError>>

Available on crate features NSData and NSError only.

pub unsafe fn URLByResolvingAliasFileAtURL_options_error( url: &NSURL, options: NSURLBookmarkResolutionOptions ) -> Result<Retained<Self>, Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn startAccessingSecurityScopedResource(&self) -> bool

pub unsafe fn stopAccessingSecurityScopedResource(&self)

impl NSURL

Methods declared on superclass NSObject

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

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

impl NSURL

NSPromisedItems

pub unsafe fn getPromisedItemResourceValue_forKey_error( &self, value: &mut Option<Retained<AnyObject>>, key: &NSURLResourceKey ) -> Result<(), Retained<NSError>>

Available on crate features NSError and NSString only.

pub unsafe fn promisedItemResourceValuesForKeys_error( &self, keys: &NSArray<NSURLResourceKey> ) -> Result<Retained<NSDictionary<NSURLResourceKey, AnyObject>>, Retained<NSError>>

Available on crate features NSArray and NSDictionary and NSError and NSString only.

pub unsafe fn checkPromisedItemIsReachableAndReturnError( &self ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

impl NSURL

This impl block contains no items.

NSItemProvider

impl NSURL

NSURLPathUtilities

pub unsafe fn fileURLWithPathComponents( components: &NSArray<NSString> ) -> Option<Retained<NSURL>>

Available on crate features NSArray and NSString only.

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

Available on crate features NSArray and NSString only.

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn URLByAppendingPathComponent( &self, path_component: &NSString ) -> Option<Retained<NSURL>>

Available on crate feature NSString only.

pub unsafe fn URLByAppendingPathComponent_isDirectory( &self, path_component: &NSString, is_directory: bool ) -> Option<Retained<NSURL>>

Available on crate feature NSString only.

pub unsafe fn URLByDeletingLastPathComponent(&self) -> Option<Retained<NSURL>>

pub unsafe fn URLByAppendingPathExtension( &self, path_extension: &NSString ) -> Option<Retained<NSURL>>

Available on crate feature NSString only.

pub unsafe fn URLByDeletingPathExtension(&self) -> Option<Retained<NSURL>>

pub unsafe fn checkResourceIsReachableAndReturnError( &self ) -> Result<(), Retained<NSError>>

Available on crate feature NSError only.

pub unsafe fn URLByStandardizingPath(&self) -> Option<Retained<NSURL>>

pub unsafe fn URLByResolvingSymlinksInPath(&self) -> Option<Retained<NSURL>>

impl NSURL

NSURLLoading

pub unsafe fn resourceDataUsingCache( &self, should_use_cache: bool ) -> Option<Retained<NSData>>

👎Deprecated: Use NSURLConnection instead

Available on crate feature NSData only.

pub unsafe fn loadResourceDataNotifyingClient_usingCache( &self, client: &AnyObject, should_use_cache: bool )

👎Deprecated: Use NSURLConnection instead

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

👎Deprecated: Use NSURLConnection instead

Available on crate feature NSString only.

pub unsafe fn setResourceData(&self, data: &NSData) -> bool

👎Deprecated: Use NSURLConnection instead

Available on crate feature NSData only.

pub unsafe fn setProperty_forKey( &self, property: &AnyObject, property_key: &NSString ) -> bool

👎Deprecated: Use NSURLConnection instead

Available on crate feature NSString only.

pub unsafe fn URLHandleUsingCache( &self, should_use_cache: bool ) -> Option<Retained<NSURLHandle>>

👎Deprecated: Use NSURLConnection instead

Available on crate feature NSURLHandle only.

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load_mut instead.

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for NSURL

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

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

impl AsMut<NSObject> for NSURL

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

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

impl AsMut<NSURL> for NSURL

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

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

impl AsRef<AnyObject> for NSURL

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURL

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURL> for NSURL

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURL

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURL

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl BorrowMut<AnyObject> for NSURL

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for NSURL

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

Mutably borrows from an owned value.

impl ClassType for NSURL

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "NSURL"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

impl Debug for NSURL

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

Formats the value using the given formatter.

impl Deref for NSURL

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for NSURL

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

Mutably dereferences the value.

impl Hash for NSURL

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 NSCoding for NSURL

Available on crate feature NSObject only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

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

where Self: Sized + Message,

Available on crate feature NSCoder only.

impl NSCopying for NSURL

Available on crate feature NSObject only.

fn copy(&self) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Returns a new instance that’s a copy of the receiver.

unsafe fn copyWithZone(&self, zone: *mut NSZone) -> Retained<Self::Immutable>

where Self: Sized + Message + CounterpartOrSelf,

Available on crate feature NSZone only.

Returns a new instance that’s a copy of the receiver.

impl NSItemProviderReading for NSURL

Available on crate feature NSItemProvider only.

unsafe fn readableTypeIdentifiersForItemProvider( ) -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

Available on crate features NSArray and NSString only.

unsafe fn objectWithItemProviderData_typeIdentifier_error( data: &NSData, type_identifier: &NSString ) -> Result<Retained<Self>, Retained<NSError>>

where Self: Sized + ClassType,

Available on crate features NSData and NSError and NSString only.

impl NSItemProviderWriting for NSURL

Available on crate feature NSItemProvider only.

unsafe fn writableTypeIdentifiersForItemProvider_class( ) -> Retained<NSArray<NSString>>

where Self: Sized + ClassType,

Available on crate features NSArray and NSString only.

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

where Self: Sized + Message,

Available on crate features NSArray and NSString only.

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier_class( type_identifier: &NSString ) -> NSItemProviderRepresentationVisibility

where Self: Sized + ClassType,

Available on crate feature NSString only.

unsafe fn itemProviderVisibilityForRepresentationWithTypeIdentifier( &self, type_identifier: &NSString ) -> NSItemProviderRepresentationVisibility

where Self: Sized + Message,

Available on crate feature NSString only.

unsafe fn loadDataWithTypeIdentifier_forItemProviderCompletionHandler( &self, type_identifier: &NSString, completion_handler: &Block<dyn Fn(*mut NSData, *mut NSError)> ) -> Option<Retained<NSProgress>>

where Self: Sized + Message,

Available on crate features NSData and NSError and NSProgress and NSString and block2 only.

impl NSObjectProtocol for NSURL

fn isEqual(&self, other: &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,

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 NSURL

Available on crate feature NSObject only.

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NSURL

fn eq(&self, other: &NSURL) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for NSURL

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

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

impl Eq for NSURL

impl Message for NSURL

impl Send for NSURL

impl StructuralPartialEq for NSURL

impl Sync for NSURL