CHANGELOG

head

No functionality changes, migrating to my custom build-tools toolchain and to zef ecosystem.


root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

ChangeLog

IP::Addr - dealing with IPv4/IPv6 addresses


NAME

my $cidr = IP::Addr.new( "192.0.2.2/27" );
say $cidr;
say $cidr.ip;
for $cidr.network.each -> $ip {
    say $ip;
}


my $cidr6 = IP::Addr.new( "600d::f00d/123" );
say $cidr6;
say $cidr6.ip;


This module provides functionality for working with IPv4/IPv6 addresses.


The main interface is provided by C<IP::Addr> class. Typical class usage is demonstrated in the synopsis. The class is
a frontend which tries to determine version of the IP address provided to its constructor and creates corresponding
handler object available on its C<handler> attribute. All methods of the handler are available on C<IP::Addr> object via
C<handles> trait.


For example, for an arbitrary C<$ip> object of the class C<$ip.ip> call is actually same as calling C<$ip.handler.ip>.
Method C<ip> is a universal one for both v4 and v6 addresses and therefore it is not necessary to care about what exact
kind of object we're currently dealing with.


Similarly, version-dependant methods are available too but only when corresponding handler is active. For example:


say IP::Addr.new( "192.0.2.2/27" ).broadcast;


say IP::Addr.new( "2001:db8::/123" ).broadcast;


will fail with "no method" exception because C<broadcast> is not available for IPv6 addresses.


Besides of its version each IP address has one more characteristic property: form. It is defined by handler's attribute
of the same name: C<$!form>. Particular forms are defined by IP-FORM enum defined in C<IP::Addr::Common>:


item

CIDR and ranges are I<ranged forms> contrary to a single IP form.


As it is known IP addresses are represented by groups of integers called I<octets> for IPv4 and I<hextets> for IPv6
(there are variations but I chose these two). I<N-tets> is used as a general term for both of them.


Class constructor C<new> simply re-dispatches its arguments to method C<set>.


Returns a valid string representation of the IP object.


Returns an iterable object which would iterate over IPs contained in the current object starting with selected address
(i.e.  the one returned by C<ip> method). For ranged forms to iterate over the whole range (from the C<first-ip> to the
C<last-ip>) use of method C<first> is recommended:


.say for IP::Addr.new( "192.0.2.3/29" ).each;           # 192.0.2.3/29\n192.0.2.4/29 ...
.say for IP::Addr.new( "192.0.2.3/29" ).first.each;     # 192.0.2.0/29\n192.0.2.1/29 ...


Similar to C<each> method but returns a C<Supply> object. Same rule about starting with selected IP and use of C<first>
method apply.


This sections documents methods common for both IPv4 and IPv6 handlers.


For all methods accepting another IP address as a parameter and where descriptions has a statement I<"same version
only"> C<X::IPAddr::TypeCheck> exception would be thrown if object with a handler of different version is passed.


Address method parameters could either be C<IP::Addr> instances or string representations.


B<Note> In the following subsection C<$handler> notation is used instead of C<$ip.handler>.


Returns number of bits for correponding IP version (I<32> for IPv4 and I<128> for IPv6).


Returns number of n-tets for the current handler (I<4> for IPv4 and I<8> for IPv6).


Returns integer version of the IP object (I<4> or I<6>).


The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


ChangeLog

CHANGELOG

v0.0.4

IP::Addr v0.0.4

Authors

License

Dependencies

Test Dependencies

Provides

Documentation