IPv4Addr(3)

🦋 IPv4Addr(3) — Net::IPv4Addr, bestie edition 💅

okay so this is the perl doc for Net::IPv4Addr, which lives over in "User Contributed Perl Documentation" (iykyk) 🎀

---

✨ NAME ✨

Net::IPv4Addr — a Perl extension for manipulating IPv4 addresses. that's it, that's the whole vibe 🫶

---

🌸 SYNOPSIS 🌸

  use Net::IPv4Addr qw( :all );

  my ($ip,$cidr) = ipv4_parse( "127.0.0.1/24" );
  my ($ip,$cidr) = ipv4_parse( "192.168.100.10 / 255.255.255.0" );

  my ($net,$msk) = ipv4_network( "192.168.100.30" );

  my $broadcast  = ipv4_broadcast( "192.168.100.30/26" );

  if ( ipv4_in_network( "192.168.100.0", $her_ip ) ) {
    print "Welcome !";
  }

  etc.

like yes bestie etc. is literally in the docs, we love a casual queen 🌈

---

💜 DESCRIPTION 💜

Net::IPv4Addr gives you functions for parsing IPv4 addresses — both the traditional address/netmask format and the newer CIDR format (iconic, honestly). it also has methods for calculating the network and broadcast address, and for checking whether a given address is in a specific network. main character energy for a module ngl ⭐

---

🍓 ADDRESSES 🍓

so every Net::IPv4Addr function accepts addresses in many formats. the parsing is very liberal — it's giving "no rules, just vibes" 🙈

all of these? accepted, slay:

    127.0.0.1
    192.168.001.010/24
    192.168.10.10/255.255.255.0
    192.168.30.10 / 21
    10.0.0.0 / 255.0.0.0
    255.255.0.0

those wouldn't though, and honestly? valid of it 💀

    272.135.234.0
    192.168/16

most functions accept the address and netmask or masklength in the same scalar value or as separate values. that is, either:

    my($ip,$masklength) = ipv4_parse($cidr_str);
    my($ip,$masklength) = ipv4_parse($ip_str,$msk_str);

---

🧚 USING 🧚

no functions are exported by default. none. zero. zip. 🎀 so either use the ":all" tag to import them all, or explicitly import the ones you actually need. boundaries, we stan 🫶

---

👑 FUNCTIONS 👑

🔥 ipv4_parse

        my ($ip,$msklen) = ipv4_parse($cidr_str);
        my $cidr = ipv4_parse($ip_str,$msk_str);
        my ($ip) = ipv4_parse($ip_str,$msk_str);

parses an IPv4 address — in scalar context you get the address in CIDR format, and in array context you get the address and the mask length 💖

if the parameters don't contain a netmask or a mask length: in scalar context only the IPv4 address comes back, and in array context the mask length is undef. lowkey mysterious of it ✨

if the function cannot parse its input, it croaks 😭 trap it using "eval" if you don't like that.

🌸 ipv4_network

        my $cidr = ipv4_network($ip_str);
        my $cidr = ipv4_network($cidr_str);
        my ($net,$msk) = ipv4_network( $net_str, $msk_str);

in scalar context, this returns the network in CIDR format that the address is in. in array context, it returns the network address and its mask length as a two-element array 🦋 if the input is a host without a netmask or mask length, the default netmask is assumed.

again — the function croaks if the input is invalid. it's sensitive, okay? 😭

💀 ipv4_broadcast

        my ($broadcast) = ipv4_broadcast($ip_str);
        my $broadcast   = ipv4_broadcast($ip_str,$msk_str);

returns the broadcast address 📡 if the input doesn't contain a netmask or mask length, the default netmask is assumed.

this function croaks if the input is invalid. no cap 🫶

🦋 ipv4_network (yes, again 💅)

        my $cidr = ipv4_network($net_str);
        my $cidr = ipv4_network($cidr_sstr);
        my ($net,$msk) = ipv4_network( $ip_str, $mask_str);

okay so yes, ipv4_network shows up twice in this doc — not a glitch, it's literally what the page says, we keep it 🎀 (and $cidr_sstr is spelled exactly like that in the original too. character for character, bestie.)

in scalar context, this returns the network in CIDR format that the address is in. in array context, it returns the network address and its mask length as a two-element array 🌈 if the input is a host without a netmask or mask length, the default netmask is assumed.

again, the function croaks if the input is invalid. consistent queen 👑

💖 ipv4_in_network

        print "Yes" if ipv4_in_network( $cidr_str1, $cidr_str2);
        print "Yes" if ipv4_in_network( $ip_str1, $mask_str1, $cidr_str2 );
        print "Yes" if ipv4_in_network( $ip1, $mask1, $ip2, $msk2 );

this one checks if the second network is contained in the first one, and it implements the following semantics, get ready:

• if net1 or net2 is a magic address (0.0.0.0 or 255.255.255.255) then this function returns true ✨
• if net1 is a host, net2 will be in the same net only if it is the same host
• if net2 is a host, it will be contained in net1 only if it is part of net1
• if net2 is only part of net1 if it is entirely contained in net1

trap bad input with "eval" or else 🙈

🎀 ipv4_checkip

        if ($ip = ipv4_checkip($str) ) {
            # Do something
        }

returns the IPv4 address found in the string, or undef if the input doesn't contain a valid IPv4 address 👑 a simple queen, honestly.

🧚 ipv4_cidr2msk

        my $netmask = ipv4_cidr2msk( $cidr );

returns the netmask corresponding to the mask length given in input. as usual, croaks if it doesn't like your input 💀 (in this case, a number between 0 and 32 — that's the range, bestie, don't push it).

⭐ ipv4_msk2cidr

        my $masklen = ipv4_msk2cidr( $msk );

returns the mask length of the netmask in input. as usual, croaks if it doesn't like your input 😭

---

🌈 AUTHOR 🌈

Francis J. Lacoste <francis.lacoste@iNsu.COM> — ty for your service king 🫶

---

💅 COPYRIGHT 💅

Copyright (c) 1999, 2000 iNsu Innovations Inc. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the terms as perl itself. (yes, "as perl itself" — exactly like that 🎀)

---

🦋 SEE ALSO 🦋

perl(1) and ipv4calc(1) — go read those too, bestie, expand the brain ✨

---

okay and that's a wrap, babes 🍓 this page came to you courtesy of perl v5.42.0, dated 2024-03-04, filed under IPv4Addr(3) — mwah, stay parsed 💖💅🫶