Struct SCNetworkReachabilityFlags 

#[repr(transparent)]
pub struct SCNetworkReachabilityFlags(pub u32);

Available on crate feature SCNetworkReachability only.

Flags that indicate whether the specified network nodename or address is reachable, whether a connection is required, and whether some user intervention may be required when establishing a connection.

This flag indicates that the specified nodename or address can be reached via a transient connection, such as PPP.

This flag indicates that the specified nodename or address can be reached using the current network configuration.

This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established.

As an example, this status would be returned for a dialup connection that was not currently active, but could handle network traffic for the target system.

This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. Any traffic directed to the specified name or address will initiate the connection.

Note: this flag was previously named kSCNetworkReachabilityFlagsConnectionAutomatic

This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. In addition, some form of user intervention will be required to establish this connection, such as providing a password, an authentication token, etc.

Note: At the present time, this flag will only be returned in the case where you have a dial-on-traffic configuration (ConnectionOnTraffic), where an attempt to connect has already been made, and where some error (e.g. no dial tone, no answer, bad password, …) was encountered during the automatic connection attempt. In this case the PPP controller will stop attempting to establish a connection until the user has intervened.

This flag indicates that the specified nodename or address can be reached using the current network configuration, but a connection must first be established. The connection will be established “On Demand” by the CFSocketStream APIs. Other APIs will not establish the connection.

This flag indicates that the specified nodename or address is one associated with a network interface on the current system.

This flag indicates that network traffic to the specified nodename or address will not go through a gateway, but is routed directly to one of the interfaces in the system.

This flag indicates that the specified nodename or address can be reached via an EDGE, GPRS, or other “cell” connection.

See also Apple’s documentation

Tuple Fields

0: u32

Implementations

impl SCNetworkReachabilityFlags

pub const TransientConnection: Self

pub const Reachable: Self

pub const ConnectionRequired: Self

pub const ConnectionOnTraffic: Self

pub const InterventionRequired: Self

pub const ConnectionOnDemand: Self

pub const IsLocalAddress: Self

pub const IsDirect: Self

pub const IsWWAN: Self

pub const ConnectionAutomatic: Self

impl SCNetworkReachabilityFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl SCNetworkReachabilityFlags

pub const fn iter(&self) -> Iter<SCNetworkReachabilityFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<SCNetworkReachabilityFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for SCNetworkReachabilityFlags

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

Formats the value using the given formatter.

impl BitAnd for SCNetworkReachabilityFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = SCNetworkReachabilityFlags

The resulting type after applying the & operator.

impl BitAndAssign for SCNetworkReachabilityFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for SCNetworkReachabilityFlags

fn bitor(self, other: SCNetworkReachabilityFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = SCNetworkReachabilityFlags

The resulting type after applying the | operator.

impl BitOrAssign for SCNetworkReachabilityFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for SCNetworkReachabilityFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = SCNetworkReachabilityFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for SCNetworkReachabilityFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for SCNetworkReachabilityFlags

fn clone(&self) -> SCNetworkReachabilityFlags

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SCNetworkReachabilityFlags

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

Formats the value using the given formatter.

impl Encode for SCNetworkReachabilityFlags

Available on crate feature objc2 only.

const ENCODING: Encoding = u32::ENCODING

The Objective-C type-encoding for this type.

impl Extend<SCNetworkReachabilityFlags> for SCNetworkReachabilityFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for SCNetworkReachabilityFlags

const FLAGS: &'static [Flag<SCNetworkReachabilityFlags>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value.

fn from_bits_retain(bits: u32) -> SCNetworkReachabilityFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<SCNetworkReachabilityFlags> for SCNetworkReachabilityFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for SCNetworkReachabilityFlags

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 IntoIterator for SCNetworkReachabilityFlags

type Item = SCNetworkReachabilityFlags

The type of the elements being iterated over.

type IntoIter = Iter<SCNetworkReachabilityFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for SCNetworkReachabilityFlags

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

Formats the value using the given formatter.

impl Not for SCNetworkReachabilityFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = SCNetworkReachabilityFlags

The resulting type after applying the ! operator.

impl Octal for SCNetworkReachabilityFlags

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

Formats the value using the given formatter.

impl Ord for SCNetworkReachabilityFlags

fn cmp(&self, other: &SCNetworkReachabilityFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SCNetworkReachabilityFlags

fn eq(&self, other: &SCNetworkReachabilityFlags) -> 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 PartialOrd for SCNetworkReachabilityFlags

fn partial_cmp(&self, other: &SCNetworkReachabilityFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RefEncode for SCNetworkReachabilityFlags

Available on crate feature objc2 only.

const ENCODING_REF: Encoding

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

impl Sub for SCNetworkReachabilityFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = SCNetworkReachabilityFlags

The resulting type after applying the - operator.

impl SubAssign for SCNetworkReachabilityFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for SCNetworkReachabilityFlags

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

Formats the value using the given formatter.

impl Copy for SCNetworkReachabilityFlags

impl Eq for SCNetworkReachabilityFlags

impl StructuralPartialEq for SCNetworkReachabilityFlags