Struct ODConfiguration 

pub struct ODConfiguration { /* private fields */ }

Available on crate feature ODConfiguration only.

Apple’s documentation

Implementations

impl ODConfiguration

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

pub unsafe fn setNodeName(&self, node_name: Option<&NSString>)

Setter for nodeName.

This is copied when set.

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

pub unsafe fn setComment(&self, comment: Option<&NSString>)

Setter for comment.

This is copied when set.

pub unsafe fn defaultMappings(&self) -> Option<Retained<ODMappings>>

Available on crate feature ODMappings only.

pub unsafe fn setDefaultMappings(&self, default_mappings: Option<&ODMappings>)

Available on crate feature ODMappings only.

Setter for defaultMappings.

Safety

default_mappings might not allow None.

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

pub unsafe fn setTemplateName(&self, template_name: Option<&NSString>)

Setter for templateName.

This is copied when set.

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

pub unsafe fn setVirtualSubnodes(&self, virtual_subnodes: Option<&NSArray>)

Setter for virtualSubnodes.

This is copied when set.

Safety

virtual_subnodes generic should be of the correct type.

pub unsafe fn hideRegistration(&self) -> bool

pub unsafe fn setHideRegistration(&self, hide_registration: bool)

Setter for hideRegistration.

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

pub unsafe fn setPreferredDestinationHostName( &self, preferred_destination_host_name: Option<&NSString>, )

Setter for preferredDestinationHostName.

This is copied when set.

pub unsafe fn preferredDestinationHostPort(&self) -> u16

pub unsafe fn setPreferredDestinationHostPort( &self, preferred_destination_host_port: u16, )

Setter for preferredDestinationHostPort.

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

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

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

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

pub unsafe fn trustUsesMutualAuthentication(&self) -> bool

pub unsafe fn trustUsesKerberosKeytab(&self) -> bool

pub unsafe fn trustUsesSystemKeychain(&self) -> bool

pub unsafe fn packetSigning(&self) -> NSInteger

pub unsafe fn setPacketSigning(&self, packet_signing: NSInteger)

Setter for packetSigning.

pub unsafe fn packetEncryption(&self) -> NSInteger

pub unsafe fn setPacketEncryption(&self, packet_encryption: NSInteger)

Setter for packetEncryption.

pub unsafe fn manInTheMiddleProtection(&self) -> bool

pub unsafe fn setManInTheMiddleProtection( &self, man_in_the_middle_protection: bool, )

Setter for manInTheMiddleProtection.

pub unsafe fn queryTimeoutInSeconds(&self) -> NSInteger

pub unsafe fn setQueryTimeoutInSeconds( &self, query_timeout_in_seconds: NSInteger, )

Setter for queryTimeoutInSeconds.

pub unsafe fn connectionSetupTimeoutInSeconds(&self) -> NSInteger

pub unsafe fn setConnectionSetupTimeoutInSeconds( &self, connection_setup_timeout_in_seconds: NSInteger, )

Setter for connectionSetupTimeoutInSeconds.

pub unsafe fn connectionIdleTimeoutInSeconds(&self) -> NSInteger

pub unsafe fn setConnectionIdleTimeoutInSeconds( &self, connection_idle_timeout_in_seconds: NSInteger, )

Setter for connectionIdleTimeoutInSeconds.

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

pub unsafe fn setDefaultModuleEntries( &self, default_module_entries: Option<&NSArray>, )

Setter for defaultModuleEntries.

This is copied when set.

Safety

default_module_entries generic should be of the correct type.

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

pub unsafe fn setAuthenticationModuleEntries( &self, authentication_module_entries: Option<&NSArray>, )

Setter for authenticationModuleEntries.

This is copied when set.

Safety

authentication_module_entries generic should be of the correct type.

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

pub unsafe fn setDiscoveryModuleEntries( &self, discovery_module_entries: Option<&NSArray>, )

Setter for discoveryModuleEntries.

This is copied when set.

Safety

discovery_module_entries generic should be of the correct type.

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

pub unsafe fn setGeneralModuleEntries( &self, general_module_entries: Option<&NSArray>, )

Setter for generalModuleEntries.

This is copied when set.

Safety

general_module_entries generic should be of the correct type.

pub unsafe fn configuration() -> Option<Retained<Self>>

Returns an initialized and autoreleased ODConfiguration object.

Returns an initialized and autoreleased ODConfiguration object.

pub unsafe fn suggestedTrustAccount( hostname: Option<&NSString>, ) -> Option<Retained<NSString>>

Returns a suggested name to use for the trust account.

Returns a suggested name to use for a trust account. This name will be derived from the hostname (if provided), otherwise it will be derived from the local hostname removing special characters that may not be allowed by many systems.

Safety

hostname might not allow None.

pub unsafe fn suggestedTrustPassword( length: usize, ) -> Option<Retained<NSString>>

Returns a suggested password to be used for trust account with the requested length.

Returns a suggested password to be used for trust account with the requested length.

pub unsafe fn saveUsingAuthorization_error( &self, authorization: Option<&SFAuthorization>, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Available on crate feature objc2-security-foundation only.

Saves the configuration using the provided authorization.

Saves the configuration using the provided authorization.

Safety

• authorization might not allow None.
• error might not allow None.

pub unsafe fn addTrustType_trustAccount_trustPassword_username_password_joinExisting_error( &self, trust_type: Option<&NSString>, account: Option<&NSString>, account_password: Option<&NSString>, username: Option<&NSString>, password: Option<&NSString>, join: bool, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Adds a trust account with the provided name and password using the credentials provided by the user.

Adds a trust account with the provided name and password using the credentials provided by the user. User can request that the trust be forcibly created (replacing existing trust if found in directory). A trust should be established only after enough configuration is available and the configuration been saved. If the trust is required, then the configuration can be deleted if necessary upon failure.

Safety

• trust_type might not allow None.
• account might not allow None.
• account_password might not allow None.
• username might not allow None.
• password might not allow None.
• error might not allow None.

pub unsafe fn removeTrustUsingUsername_password_deleteTrustAccount_error( &self, username: Option<&NSString>, password: Option<&NSString>, delete_account: bool, error: Option<&mut Option<Retained<NSError>>>, ) -> bool

Removes trust using the provided username and password.

Removes trust using the provided username and password. The trust account will be removed from the directory only if requested.

Safety

• username might not allow None.
• password might not allow None.
• error might not allow None.

impl ODConfiguration

Methods declared on superclass NSObject.

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

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 ODConfiguration

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for ODConfiguration

fn as_ref(&self) -> &NSObject

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

impl AsRef<ODConfiguration> for ODConfiguration

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for ODConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for ODConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for ODConfiguration

const NAME: &'static str = "ODConfiguration"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<ODConfiguration 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 Debug for ODConfiguration

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

Formats the value using the given formatter.

impl Deref for ODConfiguration

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for ODConfiguration

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 ODConfiguration

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for ODConfiguration

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 ODConfiguration

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 ODConfiguration

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

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

impl DowncastTarget for ODConfiguration

impl Eq for ODConfiguration