Enum `Ipv6MulticastScope`

pub enum Ipv6MulticastScope

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

Reserved0 = 0x0: Reserved by IETF.
InterfaceLocal = 0x1: Interface-Local scope.
LinkLocal = 0x2: Link-Local scope.
RealmLocal = 0x3: Realm-Local scope.
AdminLocal = 0x4: Admin-Local scope.
SiteLocal = 0x5: Site-Local scope.
Unassigned6 = 0x6: Scope 6. Unassigned, available for administrators to define additional multicast regions.
Unassigned7 = 0x7: Scope 7. Unassigned, available for administrators to define additional multicast regions.
OrganizationLocal = 0x8: Organization-Local scope.
Unassigned9 = 0x9: Scope 9. Unassigned, available for administrators to define additional multicast regions.
UnassignedA = 0xA: Scope A. Unassigned, available for administrators to define additional multicast regions.
UnassignedB = 0xB: Scope B. Unassigned, available for administrators to define additional multicast regions.
UnassignedC = 0xC: Scope C. Unassigned, available for administrators to define additional multicast regions.
UnassignedD = 0xD: Scope D. Unassigned, available for administrators to define additional multicast regions.
Global = 0xE: Global scope.
ReservedF = 0xF: Reserved by IETF.