Struct NENetworkRule 

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

The NENetworkRule class declares the programmatic interface of an object that contains a specification of a rule that matches the attributes of network traffic.

See also Apple’s documentation

Implementations

impl NENetworkRule

pub unsafe fn initWithDestinationNetwork_prefix_protocol( this: Allocated<Self>, network_endpoint: &NWHostEndpoint, destination_prefix: NSUInteger, protocol: NENetworkRuleProtocol, ) -> Retained<Self>

👎Deprecated

Initialize a newly-allocated NENetworkRule object that matches network traffic destined for a host within a specific network.

Parameter networkEndpoint: An endpoint object that contains the port and address or network that the rule matches. This endpoint must contain an address, not a hostname. If the address is a wildcard address (0.0.0.0 or ::) then the rule will match all destinations except for loopback (127.0.0.1 or ::1). To match loopback traffic set the address to the loopback address. If the port string of the endpoint is “0” or is the empty string, then the rule will match traffic on any port destined for the given address or network.

Parameter destinationPrefix: An integer that in combination with the address in the endpoint specifies the destination network that the rule matches.

Parameter protocol: A NENetworkRuleProtocol value indicating the protocol that the rule matches.

Returns: The initialized NENetworkRule instance.

pub unsafe fn initWithDestinationHost_protocol( this: Allocated<Self>, host_endpoint: &NWHostEndpoint, protocol: NENetworkRuleProtocol, ) -> Retained<Self>

👎Deprecated

Initialize a newly-allocated NENetworkRule object that matches network traffic destined for a host within a specific DNS domain.

Parameter hostEndpoint: An endpoint object that contains the port and hostname or domain that the rule matches. This endpoint must contain a hostname, not an address. If the port string of the NWHostEndpoint is “0” or is the empty string, then the rule will match traffic on any port destined for the given hostname or domain. If the hostname string of the endpoint consists of a single label, then the rule will match traffic destined to the specific host with that single label as its name. If the hostname string of the endpoint consists of 2 or more labels, then the rule will match traffic destined to hosts within the domain specified by the hostname string. Examples: [[NENetworkRule alloc] initWithDestinationHost:[NWHostEndpoint endpointWithHostname: “ com“ port:@“0”] protocol:NENetworkRuleProtocolAny] - matches all TCP and UDP traffic to the host named “com”. [[NENetworkRule alloc] initWithDestinationHost:[NWHostEndpoint endpointWithHostname: “ example.com“ port:@“0”] protocol:NENetworkRuleProtocolAny] - matches all TCP and UDP traffic to hosts in the “example.com” DNS domain, including all DNS queries for names in the example.com DNS domain. [[NENetworkRule alloc] initWithDestinationHost:[NWHostEndpoint endpointWithHostname: “ example.com“ port:@“53”] protocol:NENetworkRuleProtocolAny] - matches all DNS queries/responses for hosts in the “example.com” domain. [[NENetworkRule alloc] initWithDestinationHost:[NWHostEndpoint endpointWithHostname: “ example.com“ port:@“443”] protocol:NENetworkRuleProtocolTCP] - matches all TCP port 443 traffic to hosts in the “example.com” domain.

Parameter protocol: A NENetworkRuleProtocol value indicating the protocol that the rule matches.

Returns: The initialized NENetworkRule instance.

pub unsafe fn initWithRemoteNetwork_remotePrefix_localNetwork_localPrefix_protocol_direction( this: Allocated<Self>, remote_network: Option<&NWHostEndpoint>, remote_prefix: NSUInteger, local_network: Option<&NWHostEndpoint>, local_prefix: NSUInteger, protocol: NENetworkRuleProtocol, direction: NETrafficDirection, ) -> Retained<Self>

👎Deprecated

Initialize a newly-allocated NENetworkRule object that matches traffic by remote network, local network, protocol, and direction. If both remoteNetwork and localNetwork are nil then the rule will match all traffic of the given protocol and direction, except for loopback traffic. To match loopback traffic create a NENetworkRule with remoteNetwork and/or localNetwork properties that explicitly match traffic to the loopback address (127.0.0.1 or ::1).

Parameter remoteNetwork: An endpoint object that contains the remote port and the remote address or network that the rule matches. This endpoint must contain an address, not a hostname. If the address is a wildcard address (0.0.0.0 or ::) then the rule will match all destinations except for loopback (127.0.0.1 or ::1). To match loopback traffic set the address to the loopback address. If the port string of the endpoint is “0” or is the empty string, then the rule will match traffic on any port coming from the remote network. Pass nil to cause the rule to match any remote network.

Parameter remotePrefix: An integer that in combination with the address in remoteNetwork specifies the remote network that the rule matches.

Parameter localNetwork: An endpoint object that contains the local port and the local address or network that the rule matches. This endpoint must contain an address, not a hostname. If the address is a wildcard address (0.0.0.0 or ::) then the rule will match all local networks except for loopback (127.0.0.1 or ::1). To match loopback traffic set the address to the loopback address. If the port string of the endpoint is “0” or is the empty string, then the rule will match traffic on any port coming from the local network. Pass nil to cause the rule to match any local network.

Parameter localPrefix: An integer that in combination with the address in localNetwork specifies the local network that the rule matches. This parameter is ignored if localNetwork is nil.

Parameter protocol: A NENetworkRuleProtocol value indicating the protocol that the rule matches.

Parameter direction: A NETrafficDirection value indicating the direction of network traffic that the rule matches.

Returns: The initialized NENetworkRule instance.

pub unsafe fn matchRemoteEndpoint(&self) -> Option<Retained<NWHostEndpoint>>

👎Deprecated

The remote endpoint that the rule matches.

pub unsafe fn matchRemotePrefix(&self) -> NSUInteger

A number that specifies the remote sub-network that the rule matches. This property is set to NSNotFound for rules where matchRemoteEndpoint does not contain an IP address.

pub unsafe fn matchLocalNetwork(&self) -> Option<Retained<NWHostEndpoint>>

👎Deprecated

The local network that the rule matches.

pub unsafe fn matchLocalPrefix(&self) -> NSUInteger

A number that specifies the local sub-network that the rule matches. This property is set to NSNotFound for rules with a nil matchLocalNetwork property.

pub unsafe fn matchProtocol(&self) -> NENetworkRuleProtocol

A NENetworkRuleProtocol value containing the protocol that the rule matches.

pub unsafe fn matchDirection(&self) -> NETrafficDirection

A NETrafficDirection value indicating the network traffic direction that the rule matches.

impl NENetworkRule

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 NENetworkRule

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NENetworkRule> for NENetworkRule

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for NENetworkRule

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for NENetworkRule

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for NENetworkRule

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for NENetworkRule

const NAME: &'static str = "NENetworkRule"

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

type Super = NSObject

The superclass of this class.

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

type Result = NENetworkRule

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

impl Debug for NENetworkRule

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

Formats the value using the given formatter.

impl Deref for NENetworkRule

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for NENetworkRule

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 NENetworkRule

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCopying for NENetworkRule

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

where Self: Sized + Message + CopyingHelper,

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,

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

impl NSObjectProtocol for NENetworkRule

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 NENetworkRule

unsafe fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for NENetworkRule

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 NENetworkRule

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

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

impl DowncastTarget for NENetworkRule

impl Eq for NENetworkRule

impl NSCoding for NENetworkRule