Struct NSURLComponents

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

Available on crate feature NSURL only.

Apple’s documentation

Implementations

impl NSURLComponents

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

pub unsafe fn initWithURL_resolvingAgainstBaseURL( this: Allocated<Self>, url: &NSURL, resolve: bool, ) -> Option<Retained<Self>>

pub unsafe fn componentsWithURL_resolvingAgainstBaseURL( url: &NSURL, resolve: bool, ) -> Option<Retained<Self>>

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

Available on crate feature NSString only.

pub unsafe fn componentsWithString( url_string: &NSString, ) -> 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.

Initializes an NSURLComponents with a URL string and the option to add (or skip) IDNA- and percent-encoding of invalid characters. If encodingInvalidCharacters is false, and the URL string is invalid according to RFC 3986, nil is returned. If encodingInvalidCharacters is true, NSURLComponents will try to encode the string to create a valid URL. If the URL string is still invalid after encoding, nil is returned.

• Parameter URLString: The URL string.
• Parameter encodingInvalidCharacters: True if NSURLComponents should try to encode an invalid URL string, false otherwise.
• Returns: An NSURLComponents instance for a valid URL, or nil if the URL is invalid.

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

Available on crate feature NSString only.

Initializes and returns a newly created NSURLComponents with a URL string and the option to add (or skip) IDNA- and percent-encoding of invalid characters. If encodingInvalidCharacters is false, and the URL string is invalid according to RFC 3986, nil is returned. If encodingInvalidCharacters is true, NSURLComponents will try to encode the string to create a valid URL. If the URL string is still invalid after encoding, nil is returned.

• Parameter URLString: The URL string.
• Parameter encodingInvalidCharacters: True if NSURLComponents should try to encode an invalid URL string, false otherwise.
• Returns: An NSURLComponents instance for a valid URL, or nil if the URL is invalid.

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

pub unsafe fn URLRelativeToURL( &self, base_url: Option<&NSURL>, ) -> Option<Retained<NSURL>>

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

Available on crate feature NSString only.

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

Available on crate feature NSString only.

pub unsafe fn setScheme(&self, scheme: Option<&NSString>)

Available on crate feature NSString only.

Setter for scheme.

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

Available on crate feature NSString only.

pub unsafe fn setUser(&self, user: Option<&NSString>)

Available on crate feature NSString only.

Setter for user.

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

Available on crate feature NSString only.

pub unsafe fn setPassword(&self, password: Option<&NSString>)

Available on crate feature NSString only.

Setter for password.

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

Available on crate feature NSString only.

pub unsafe fn setHost(&self, host: Option<&NSString>)

Available on crate feature NSString only.

Setter for host.

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

Available on crate feature NSValue only.

pub unsafe fn setPort(&self, port: Option<&NSNumber>)

Available on crate feature NSValue only.

Setter for port.

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

Available on crate feature NSString only.

pub unsafe fn setPath(&self, path: Option<&NSString>)

Available on crate feature NSString only.

Setter for path.

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

Available on crate feature NSString only.

pub unsafe fn setQuery(&self, query: Option<&NSString>)

Available on crate feature NSString only.

Setter for query.

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

Available on crate feature NSString only.

pub unsafe fn setFragment(&self, fragment: Option<&NSString>)

Available on crate feature NSString only.

Setter for fragment.

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

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedUser( &self, percent_encoded_user: Option<&NSString>, )

Available on crate feature NSString only.

Setter for percentEncodedUser.

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

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedPassword( &self, percent_encoded_password: Option<&NSString>, )

Available on crate feature NSString only.

Setter for percentEncodedPassword.

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

👎Deprecated: Use encodedHost instead

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedHost( &self, percent_encoded_host: Option<&NSString>, )

👎Deprecated: Use encodedHost instead

Available on crate feature NSString only.

Setter for percentEncodedHost.

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

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedPath( &self, percent_encoded_path: Option<&NSString>, )

Available on crate feature NSString only.

Setter for percentEncodedPath.

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

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedQuery( &self, percent_encoded_query: Option<&NSString>, )

Available on crate feature NSString only.

Setter for percentEncodedQuery.

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

Available on crate feature NSString only.

pub unsafe fn setPercentEncodedFragment( &self, percent_encoded_fragment: Option<&NSString>, )

Available on crate feature NSString only.

Setter for percentEncodedFragment.

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

Available on crate feature NSString only.

pub unsafe fn setEncodedHost(&self, encoded_host: Option<&NSString>)

Available on crate feature NSString only.

Setter for encodedHost.

pub unsafe fn rangeOfScheme(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfUser(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfPassword(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfHost(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfPort(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfPath(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfQuery(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn rangeOfFragment(&self) -> NSRange

Available on crate feature NSRange only.

pub unsafe fn queryItems(&self) -> Option<Retained<NSArray<NSURLQueryItem>>>

Available on crate feature NSArray only.

pub unsafe fn setQueryItems( &self, query_items: Option<&NSArray<NSURLQueryItem>>, )

Available on crate feature NSArray only.

Setter for queryItems.

pub unsafe fn percentEncodedQueryItems( &self, ) -> Option<Retained<NSArray<NSURLQueryItem>>>

Available on crate feature NSArray only.

pub unsafe fn setPercentEncodedQueryItems( &self, percent_encoded_query_items: Option<&NSArray<NSURLQueryItem>>, )

Available on crate feature NSArray only.

Setter for percentEncodedQueryItems.

impl NSURLComponents

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 NSURLComponents

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for NSURLComponents

fn as_ref(&self) -> &NSObject

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

impl AsRef<NSURLComponents> for NSURLComponents

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for NSURLComponents

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NSURLComponents

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NSURLComponents

const NAME: &'static str = "NSURLComponents"

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

type Super = NSObject

The superclass of this class.

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

Available on crate feature NSObject only.

type Result = NSURLComponents

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

impl Debug for NSURLComponents

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

Formats the value using the given formatter.

impl Deref for NSURLComponents

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NSURLComponents

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 NSURLComponents

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NSURLComponents

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 NSURLComponents

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 NSURLComponents

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 NSURLComponents

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

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

impl DowncastTarget for NSURLComponents

impl Eq for NSURLComponents