Struct DistributionFlags 

pub struct DistributionFlags(/* private fields */);

Distribution flags.

Implementations

impl DistributionFlags

pub const PUBLISHED: Self

The node is to be published and part of the global namespace.

pub const ATOM_CACHE: Self

The node implements an atom cache (obsolete).

pub const EXTENDED_REFERENCES: Self

The node implements extended (3 × 32 bits) references (required).

[NOTE] This flag is mandatory. If not present, the connection is refused.

pub const DIST_MONITOR: Self

The node implements distributed process monitoring.

[NOTE] This flag will become mandatory in OTP 25.

pub const FUN_TAGS: Self

The node uses separate tag for funs (lambdas) in the distribution protocol.

pub const DIST_MONITOR_NAME: Self

The node implements distributed named process monitoring.

pub const HIDDEN_ATOM_CACHE: Self

The (hidden) node implements atom cache (obsolete).

pub const NEW_FUN_TAGS: Self

The node understands new fun tags.

[NOTE] This flag is mandatory. If not present, the connection is refused.

pub const EXTENDED_PIDS_PORTS: Self

The node can handle extended pids and ports (required).

[NOTE] This flag is mandatory. If not present, the connection is refused.

pub const EXPORT_PTR_TAG: Self

This node understands EXPORT_EXT tag.

[NOTE] This flag will become mandatory in OTP 25.

pub const BIT_BINARIES: Self

The node understands bit binaries.

[NOTE] This flag will become mandatory in OTP 25.

pub const NEW_FLOATS: Self

The node understandss new float format.

[NOTE] This flag will become mandatory in OTP 25.

pub const UNICODE_IO: Self

This node allows unicode characters in I/O operations.

pub const DIST_HDR_ATOM_CACHE: Self

The node implements atom cache in distribution header.

Note that currently erl_dist can not handle distribution headers.

pub const SMALL_ATOM_TAGS: Self

The node understands the SMALL_ATOM_EXT tag.

pub const UTF8_ATOMS: Self

The node understands UTF-8 encoded atoms.

[NOTE] This flag is mandatory. If not present, the connection is refused.

pub const MAP_TAGS: Self

The node understands maps.

[NOTE] This flag will become mandatory in OTP 25.

pub const BIG_CREATION: Self

The node understands big node creation tags NEW_PID_EXT, NEW_PORT_EXT and NEWER_REFERENCE_EXT.

[NOTE] This flag is mandatory. If not present, the connection is refused.

pub const SEND_SENDER: Self

Use the SEND_SENDER control message instead of the SEND control message and use the SEND_SENDER_TT control message instead of the SEND_TT control message.

pub const BIG_SEQTRACE_LABELS: Self

The node understands any term as the seqtrace label.

pub const EXIT_PAYLOAD: Self

Use the PAYLOAD_EXIT, PAYLOAD_EXIT_TT, PAYLOAD_EXIT2, PAYLOAD_EXIT2_TT and PAYLOAD_MONITOR_P_EXIT control messages instead of the non-PAYLOAD variants.

pub const FRAGMENTS: Self

Use fragmented distribution messages to send large messages.

pub const HANDSHAKE_23: Self

The node supports the new connection setup handshake (version 6) introduced in OTP 23.

pub const UNLINK_ID: Self

Use the new link protocol.

Unless both nodes have set the UNLINK_ID flag, the old link protocol will be used as a fallback.

[NOTE] This flag will become mandatory in OTP 25.

pub const SPAWN: Self

Set if the SPAWN_REQUEST, SPAWN_REQUEST_TT, SPAWN_REPLY, SPAWN_REPLY_TT control messages are supported.

pub const NAME_ME: Self

Dynamic node name.

This is not a capability but rather used as a request from the connecting node to receive its node name from the accepting node as part of the handshake.

pub const V4_NC: Self

The node accepts a larger amount of data in pids, ports and references (node container types version 4).

In the pid case full 32-bit ID and Serial fields in NEW_PID_EXT, in the port case a 64-bit integer in V4_PORT_EXT, and in the reference case up to 5 32-bit ID words are now accepted in NEWER_REFERENCE_EXT. Introduced in OTP 24.

[NOTE] This flag will become mandatory in OTP 26.

pub const ALIAS: Self

The node supports process alias and can by this handle the ALIAS_SEND and ALIAS_SEND_TT control messages.

Introduced in OTP 24.

pub const MANDATORY_25_DIGEST: Self

The node supports all capabilities that are mandatory in OTP 25.

Introduced in OTP 25. [NOTE] This flag will become mandatory in OTP 27.

impl DistributionFlags

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) -> u64

Get the underlying bits value.

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

pub const fn from_bits(bits: u64) -> 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: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> 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 DistributionFlags

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

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<DistributionFlags>

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.

impl DistributionFlags

pub fn new() -> Self

Makes a new DistributionFlags with the default flags.

This is equivalent to the following code:

DistributionFlags::mandatory();

pub fn mandatory() -> Self

Gets the mandatory flags (in OTP 26).

Trait Implementations

impl Binary for DistributionFlags

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

Formats the value using the given formatter.

impl BitAnd for DistributionFlags

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

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

type Output = DistributionFlags

The resulting type after applying the & operator.

impl BitAndAssign for DistributionFlags

fn bitand_assign(&mut self, other: Self)

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

impl BitOr for DistributionFlags

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

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

type Output = DistributionFlags

The resulting type after applying the | operator.

impl BitOrAssign for DistributionFlags

fn bitor_assign(&mut self, other: Self)

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

impl BitXor for DistributionFlags

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

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

type Output = DistributionFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for DistributionFlags

fn bitxor_assign(&mut self, other: Self)

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

impl Clone for DistributionFlags

fn clone(&self) -> DistributionFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DistributionFlags

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

Formats the value using the given formatter.

impl Default for DistributionFlags

fn default() -> Self

Returns the “default value” for a type.

impl Extend<DistributionFlags> for DistributionFlags

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 DistributionFlags

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

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> DistributionFlags

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<DistributionFlags> for DistributionFlags

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

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

impl Hash for DistributionFlags

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 DistributionFlags

type Item = DistributionFlags

The type of the elements being iterated over.

type IntoIter = Iter<DistributionFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for DistributionFlags

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

Formats the value using the given formatter.

impl Not for DistributionFlags

fn not(self) -> Self

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

type Output = DistributionFlags

The resulting type after applying the ! operator.

impl Octal for DistributionFlags

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

Formats the value using the given formatter.

impl PartialEq for DistributionFlags

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

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for DistributionFlags

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 = DistributionFlags

The resulting type after applying the - operator.

impl SubAssign for DistributionFlags

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 DistributionFlags

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

Formats the value using the given formatter.

impl Copy for DistributionFlags

impl Eq for DistributionFlags

impl StructuralPartialEq for DistributionFlags