Enum Ipv6MulticastScope 

pub enum Ipv6MulticastScope {
    InterfaceLocal = 1,
    LinkLocal = 2,
    RealmLocal = 3,
    AdminLocal = 4,
    SiteLocal = 5,
    Unassigned6 = 6,
    Unassigned7 = 7,
    OrganizationLocal = 8,
    Unassigned9 = 9,
    UnassignedA = 10,
    UnassignedB = 11,
    UnassignedC = 12,
    UnassignedD = 13,
    Global = 14,
    // some variants omitted
}

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

Scope of an IPv6 multicast address as defined in IETF RFC 7346 section 2, which updates IETF RFC 4291 section 2.7.

Stability Guarantees

Scopes 0 and F are currently reserved by IETF, and may be assigned in the future. For this reason, the enum variants for those two scopes are not currently nameable. You can still check for them in your code using as casts.

Examples

#![feature(ip)]

use std::net::Ipv6Addr;
use std::net::Ipv6MulticastScope::*;

// An IPv6 multicast address with global scope (`ff0e::`).
let address = Ipv6Addr::new(0xff0e, 0, 0, 0, 0, 0, 0, 0);

// Will print "Global scope".
match address.multicast_scope() {
    Some(InterfaceLocal) => println!("Interface-Local scope"),
    Some(LinkLocal) => println!("Link-Local scope"),
    Some(RealmLocal) => println!("Realm-Local scope"),
    Some(AdminLocal) => println!("Admin-Local scope"),
    Some(SiteLocal) => println!("Site-Local scope"),
    Some(OrganizationLocal) => println!("Organization-Local scope"),
    Some(Global) => println!("Global scope"),
    Some(s) => {
        let snum = s as u8;
        if matches!(0x0 | 0xF, snum) {
            println!("Reserved scope {snum:X}")
        } else {
            println!("Unassigned scope {snum:X}")
        }
    }
    None => println!("Not a multicast address!")
}

Variants

InterfaceLocal = 1

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

Interface-Local scope.

LinkLocal = 2

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

Link-Local scope.

RealmLocal = 3

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

Realm-Local scope.

AdminLocal = 4

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

Admin-Local scope.

SiteLocal = 5

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

Site-Local scope.

Unassigned6 = 6

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

Scope 6. Unassigned, available for administrators to define additional multicast regions.

Unassigned7 = 7

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

Scope 7. Unassigned, available for administrators to define additional multicast regions.

OrganizationLocal = 8

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

Organization-Local scope.

Unassigned9 = 9

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

Scope 9. Unassigned, available for administrators to define additional multicast regions.

UnassignedA = 10

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

Scope A. Unassigned, available for administrators to define additional multicast regions.

UnassignedB = 11

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

Scope B. Unassigned, available for administrators to define additional multicast regions.

UnassignedC = 12

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

Scope C. Unassigned, available for administrators to define additional multicast regions.

UnassignedD = 13

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

Scope D. Unassigned, available for administrators to define additional multicast regions.

Global = 14

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

Global scope.

Trait Implementations

impl Clone for Ipv6MulticastScope

fn clone(&self) -> Ipv6MulticastScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ipv6MulticastScope

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

Formats the value using the given formatter.

impl Hash for Ipv6MulticastScope

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for Ipv6MulticastScope

fn cmp(&self, other: &Ipv6MulticastScope) -> 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 Ipv6MulticastScope

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

fn partial_cmp(&self, other: &Ipv6MulticastScope) -> 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 Copy for Ipv6MulticastScope

impl Eq for Ipv6MulticastScope

impl StructuralPartialEq for Ipv6MulticastScope