Ribs

Appearance

ribs_ip›Classes›Ipv4Address

Ipv4Address final ​

final class Ipv4Address extends IpAddress

A 32-bit IPv4 address stored as 4 bytes in network (big-endian) order.

Textual form is dotted-decimal notation: "192.168.1.1".

Inheritance

Object → Ordered<A> → Host → IpAddress → Ipv4Address

Properties ​

asHost no setter inherited ​

Host get asHost

Returns this as a Host (identity).

Inherited from Host.

Implementation
dart
Host get asHost => this;

asIpAddress no setter inherited ​

IpAddress get asIpAddress

Returns this as an IpAddress (identity).

Inherited from IpAddress.

Implementation
dart
IpAddress get asIpAddress => this;

bitSize no setter inherited ​

int get bitSize

The number of bits in this address (32 for IPv4, 128 for IPv6).

Inherited from IpAddress.

Implementation
dart
int get bitSize => fold((_) => 32, (_) => 128);

hashCode no setter inherited ​

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from IpAddress.

Implementation
dart
@override
int get hashCode => Object.hashAll(_bytes);

isMappedV4 no setter inherited ​

bool get isMappedV4

Returns true if this is an IPv6 address in the ::ffff:0:0/96 (IPv4-mapped) block.

Inherited from IpAddress.

Implementation
dart
bool get isMappedV4 => fold((_) => false, Ipv6Address.MappedV4Block.contains);

isMulticast no setter override ​

bool get isMulticast

Returns true if this address is in the multicast range.

Implementation
dart
@override
bool get isMulticast => multicastRangeStart <= this && this <= multicastRangeEnd;

isSourceSpecificMulticast no setter override ​

bool get isSourceSpecificMulticast

Returns true if this address is in the source-specific multicast (SSM) range.

Implementation
dart
@override
bool get isSourceSpecificMulticast =>
    sourceSpecificMulticastRangeStart <= this && this <= sourceSpecificMulticastRangeEnd;

runtimeType no setter inherited ​

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation
dart
external Type get runtimeType;

version no setter inherited ​

IpVersion get version

The IP version of this address.

Inherited from IpAddress.

Implementation
dart
IpVersion get version => fold((_) => IpVersion.v4, (_) => IpVersion.v6);

Methods ​

asIpv4() inherited ​

Option<Ipv4Address> asIpv4()

Returns Some(v4) if this address is (or collapses to) an Ipv4Address, otherwise None.

Inherited from IpAddress.

Implementation
dart
Option<Ipv4Address> asIpv4() => collapseMappedV4().fold((v4) => Some(v4), (_) => none());

asIpv6() inherited ​

Option<Ipv6Address> asIpv6()

Returns Some(v6) if this is an Ipv6Address, otherwise None.

Inherited from IpAddress.

Implementation
dart
Option<Ipv6Address> asIpv6() => fold((_) => none(), (v6) => Some(v6));

asMulticast() override ​

Option<Multicast<Ipv4Address>> asMulticast()

Returns a Multicast wrapper if this address is a multicast address, otherwise None.

Implementation
dart
@override
Option<Multicast<Ipv4Address>> asMulticast() => Multicast.fromIpAddress(this);

asSourceSpecificMulticast() override ​

Option<SourceSpecificMulticastStrict<Ipv4Address>> asSourceSpecificMulticast()

Returns a strict SourceSpecificMulticastStrict wrapper if this address is in the SSM range, otherwise None.

Implementation
dart
@override
Option<SourceSpecificMulticastStrict<Ipv4Address>> asSourceSpecificMulticast() =>
    SourceSpecificMulticast.fromIpAddress(this);

asSourceSpecificMulticastLenient() override ​

Option<SourceSpecificMulticast<Ipv4Address>> asSourceSpecificMulticastLenient()

Returns a lenient SourceSpecificMulticast wrapper if this address is any multicast address, otherwise None.

Implementation
dart
@override
Option<SourceSpecificMulticast<Ipv4Address>> asSourceSpecificMulticastLenient() =>
    SourceSpecificMulticast.fromIpAddressLenient(this);

collapseMappedV4() inherited ​

IpAddress collapseMappedV4()

If this is an IPv6 address that is a mapped IPv4 address (i.e. ::ffff:a.b.c.d), returns the corresponding Ipv4Address. Otherwise returns this address unchanged.

Inherited from IpAddress.

Implementation
dart
IpAddress collapseMappedV4() => fold(identity, (v6) {
  if (v6.isMappedV4) {
    return IpAddress.fromBytes(
      v6.toBytes().toIList().takeRight(4).toList(),
    ).getOrElse(() => throw Exception('IpAddress.collapseMappedV4 failure: $v6'));
  } else {
    return v6;
  }
});

compareTo() inherited ​

int compareTo(Host that)

Compares this object to another object.

Returns a value like a Comparator when comparing this to other. That is, it returns a negative integer if this is ordered before other, a positive integer if this is ordered after other, and zero if this and other are ordered together.

The other argument must be a value that is comparable to this object.

Inherited from Host.

Implementation
dart
@override
int compareTo(Host that) {
  return switch (this) {
    final Ipv4Address x => switch (that) {
      final Ipv4Address y => IpAddress.compareBytes(x, y),
      final Ipv6Address y => IpAddress.compareBytes(x.toCompatV6(), y),
      _ => -1,
    },
    final Ipv6Address x => switch (that) {
      final Ipv4Address y => IpAddress.compareBytes(x, y.toCompatV6()),
      final Ipv6Address y => IpAddress.compareBytes(x, y),
      _ => -1,
    },
    final Hostname x => switch (that) {
      final Ipv4Address _ => 1,
      final Ipv6Address _ => 1,
      final Hostname y => x.toString().compareTo(y.toString()),
      final IDN y => x.toString().compareTo(y.hostname.toString()),
    },
    final IDN x => switch (that) {
      final Ipv4Address _ => 1,
      final Ipv6Address _ => 1,
      final Hostname y => x.hostname.toString().compareTo(y.toString()),
      final IDN y => x.hostname.toString().compareTo(y.hostname.toString()),
    },
  };
}

fold() override ​

A fold<A>(A Function(Ipv4Address) v4, A Function(Ipv6Address) v6)

Dispatches to v4 or v6 depending on the address family.

Implementation
dart
@override
A fold<A>(
  Function1<Ipv4Address, A> v4,
  Function1<Ipv6Address, A> v6,
) => v4(this);

masked() ​

Ipv4Address masked(Ipv4Address mask)

Returns this address ANDed with mask (bitwise AND).

Implementation
dart
Ipv4Address masked(Ipv4Address mask) => Ipv4Address.fromInt(toInt() & mask.toInt());

maskedLast() ​

Ipv4Address maskedLast(Ipv4Address mask)

Returns the last address in the subnet defined by mask (bitwise OR of network prefix with the inverted mask).

Implementation
dart
Ipv4Address maskedLast(Ipv4Address mask) =>
    Ipv4Address.fromInt(toInt() & mask.toInt() | ~mask.toInt());

next() ​

Ipv4Address next()

Returns the address that follows this one (wraps around on overflow).

Implementation
dart
Ipv4Address next() => Ipv4Address.fromInt(toInt() + 1);

noSuchMethod() inherited ​

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dart
dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

dart
class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation
dart
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

prefixBits() inherited ​

int prefixBits()

Counts the number of leading one-bits in the address, treating the bytes as a network mask. Used to derive the prefix length from a mask address.

Inherited from IpAddress.

Implementation
dart
int prefixBits() {
  int zerosIn(int value, int bits) {
    int res = 0;
    int x = value;

    while ((x & (1 << (bits - 1))) == 0 && res < bits) {
      x = x << 1;
      res++;
    }

    return res;
  }

  int zeros(Uint8List l) {
    int n = 0;

    for (final i in l) {
      n += zerosIn(~i, 8);

      if (n == 0 || n % 8 != 0) {
        return n;
      }
    }

    return n;
  }

  return zeros(_bytes);
}

previous() ​

Ipv4Address previous()

Returns the address that precedes this one (wraps around on underflow).

Implementation
dart
Ipv4Address previous() => Ipv4Address.fromInt(toInt() - 1);

resolve() inherited ​

IO<IList<IpAddress>> resolve()

Resolves this host to a list of IpAddress values.

If this is already an IpAddress, returns it immediately. For Hostname and IDN values, performs a DNS lookup via Dns.resolve.

Inherited from Host.

Implementation
dart
IO<IList<IpAddress>> resolve() => switch (this) {
  final IpAddress ip => IO.pure(ilist([ip])),
  final Hostname hostname => Dns.resolve(hostname),
  final IDN idn => Dns.resolve(idn.hostname),
};

reverse() inherited ​

IO<Hostname> reverse()

Performs a reverse DNS lookup, returning the Hostname associated with this address. Fails the IO if no PTR record is found.

Inherited from IpAddress.

Implementation
dart
IO<Hostname> reverse() => Dns.reverse(this);

reverseOption() inherited ​

IO<Option<Hostname>> reverseOption()

Performs a reverse DNS lookup, returning Some hostname if a PTR record exists or None otherwise.

Inherited from IpAddress.

Implementation
dart
IO<Option<Hostname>> reverseOption() => Dns.reverseOption(this);

toBytes() inherited ​

Uint8List toBytes()

Returns a copy of the underlying bytes as a new Uint8List.

Inherited from IpAddress.

Implementation
dart
Uint8List toBytes() => Uint8List.fromList(_bytes.toList());

toCompatV6() ​

Ipv6Address toCompatV6()

Returns the IPv4-compatible IPv6 representation (::a.b.c.d).

Implementation
dart
Ipv6Address toCompatV6() {
  final compat = Uint8List(16);

  compat[12] = _bytes[0];
  compat[13] = _bytes[1];
  compat[14] = _bytes[2];
  compat[15] = _bytes[3];

  return Ipv6Address.fromByteList(
    compat,
  ).getOrElse(() => throw Exception('Error converting $this to compatible IPv6'));
}

toInt() ​

int toInt()

Returns the address as a 32-bit unsigned integer in network byte order.

Implementation
dart
int toInt() => _bytes.fold(0, (acc, b) => (acc << 8) | (0x0ff & b));

toMappedV6() ​

Ipv6Address toMappedV6()

Returns the IPv4-mapped IPv6 representation (::ffff:a.b.c.d).

Implementation
dart
Ipv6Address toMappedV6() {
  final mapped = Uint8List(16);

  mapped[10] = 255;
  mapped[11] = 255;
  mapped[12] = _bytes[0];
  mapped[13] = _bytes[1];
  mapped[14] = _bytes[2];
  mapped[15] = _bytes[3];

  return Ipv6Address.fromByteList(
    mapped,
  ).getOrElse(() => throw Exception('Error converting $this to mapped IPv6'));
}

toString() override ​

String toString()

Returns the dotted-decimal string, e.g. "192.168.1.1".

Implementation
dart
@override
String toString() =>
    '${_bytes[0] & 0xff}.${_bytes[1] & 0xff}.${_bytes[2] & 0xff}.${_bytes[3] & 0xff}';

Operators ​

operator /() override ​

Cidr<Ipv4Address> operator /(int prefixBits)

Creates a Cidr block from this address and prefixBits.

Implementation
dart
@override
Cidr<Ipv4Address> operator &#47;(int prefixBits) => Cidr.of(this, prefixBits);

operator <() inherited ​

bool operator <(Host that)

Returns true if this value is less than that.

Inherited from Ordered.

Implementation
dart
bool operator <(A that) => compareTo(that) < 0;

operator <=() inherited ​

bool operator <=(Host that)

Returns true if this value is less than or equal to that.

Inherited from Ordered.

Implementation
dart
bool operator <=(A that) => compareTo(that) <= 0;

operator ==() inherited ​

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from IpAddress.

Implementation
dart
@override
bool operator ==(Object other) => switch (other) {
  final IpAddress that =>
    version == that.version && ilist(_bytes).zip(ilist(that._bytes)).forall((t) => t.$1 == t.$2),
  _ => false,
};

operator >() inherited ​

bool operator >(Host that)

Returns true if this value is greater than that.

Inherited from Ordered.

Implementation
dart
bool operator >(A that) => compareTo(that) > 0;

operator >=() inherited ​

bool operator >=(Host that)

Returns true if this value is greater than or equal to that.

Inherited from Ordered.

Implementation
dart
bool operator >=(A that) => compareTo(that) >= 0;

Static Properties ​

multicastRangeEnd final ​

final Ipv4Address multicastRangeEnd

Last IP address in the IPv4 multicast range (239.255.255.255).

Implementation
dart
static final multicastRangeEnd = fromBytes(239, 255, 255, 255);

multicastRangeStart final ​

final Ipv4Address multicastRangeStart

First IP address in the IPv4 multicast range (224.0.0.0).

Implementation
dart
static final multicastRangeStart = fromBytes(224, 0, 0, 0);

sourceSpecificMulticastRangeEnd final ​

final Ipv4Address sourceSpecificMulticastRangeEnd

Last IP address in the IPv4 source specific multicast range (232.255.255.255).

Implementation
dart
static final sourceSpecificMulticastRangeEnd = fromBytes(232, 255, 255, 255);

sourceSpecificMulticastRangeStart final ​

final Ipv4Address sourceSpecificMulticastRangeStart

First IP address in the IPv4 source specific multicast range (232.0.0.0).

Implementation
dart
static final sourceSpecificMulticastRangeStart = fromBytes(232, 0, 0, 0);

Wildcard final ​

final Ipv4Address Wildcard

The wildcard IPv4 address 0.0.0.0.

Implementation
dart
static final Wildcard = Ipv4Address._(Uint8List.fromList([0, 0, 0, 0]));

Static Methods ​

fromByteList() ​

Option<Ipv4Address> fromByteList(Iterable<int> bytes)

Returns an Ipv4Address from an iterable of exactly 4 bytes, or None otherwise.

Implementation
dart
static Option<Ipv4Address> fromByteList(Iterable<int> bytes) =>
    Option.when(() => bytes.length == 4, () => _unsafeFromBytes(bytes));

fromBytes() override ​

Ipv4Address fromBytes(int a, int b, int c, int d)

Creates an Ipv4Address from four individual byte values. Each byte is masked to 8 bits.

Implementation
dart
static Ipv4Address fromBytes(int a, int b, int c, int d) =>
    _unsafeFromBytes(Uint8List.fromList([a & 0xff, b & 0xff, c & 0xff, d & 0xff]));

fromInt() ​

Ipv4Address fromInt(int value)

Creates an Ipv4Address from a 32-bit integer in network byte order.

Implementation
dart
static Ipv4Address fromInt(int value) {
  final bytes = Uint8List(4);

  var rem = value;

  Range.inclusive(3, 0, -1).foreach((i) {
    bytes[i] = rem & 0x0ff;
    rem = rem >> 8;
  });

  return _unsafeFromBytes(bytes);
}

fromString() override ​

Option<Ipv4Address> fromString(String value)

Parses a dotted-decimal IPv4 string (e.g. "192.168.1.1"), returning None if parsing fails.

Implementation
dart
static Option<Ipv4Address> fromString(String value) {
  final trimmed = value.trim();
  final fields = trimmed.split('.');

  if (fields.length == 4) {
    final bytes = Uint8List(4);
    int idx = 0;

    while (idx < bytes.length) {
      final value = int.tryParse(fields[idx]) ?? -1;
      if (0 <= value && value <= 255) {
        bytes[idx] = value;
      } else {
        return none();
      }

      idx++;
    }

    return Some(_unsafeFromBytes(bytes));
  } else {
    return none();
  }
}

loopback() override ​

IO<IList<IpAddress>> loopback()

Returns the IPv4 loopback addresses for the current host.

Implementation
dart
static IO<IList<IpAddress>> loopback() =>
    IpAddress.loopback().map((ifaces) => ifaces.filter((iface) => iface.version == IpVersion.v4));

mask() ​

Ipv4Address mask(int bits)

Returns the subnet mask address for the given bits prefix length (0–32, clamped).

Implementation
dart
static Ipv4Address mask(int bits) {
  final b = bits.clamp(0, 32);
  if (b == 0) return Ipv4Address.fromInt(0);
  final val = (BigInt.one << 32) - (BigInt.one << (32 - b));
  return Ipv4Address.fromInt(val.toInt());
}