effect 4.0.0-rc.112 → 4.0.0-rc.113

package/dist/unstable/net/IpInterface.d.ts

@@ -0,0 +1,140 @@
+/**
+ * IPv4 and IPv6 interface addresses that preserve host bits alongside a prefix length.
+ *
+ * @since 4.0.0
+ */
+import * as Equal from "../../Equal.ts";
+import * as Hash from "../../Hash.ts";
+import * as Result from "../../Result.ts";
+import * as NetAddress from "./NetAddress.ts";
+declare const TypeId: "~effect/net/IpInterface";
+/**
+ * An IP host address and prefix length. Host bits are preserved.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface IpInterface<out A extends NetAddress.IpAddress = NetAddress.IpAddress> extends Equal.Equal, Hash.Hash {
+    readonly _tag: "IpInterface";
+    readonly address: A;
+    readonly prefixLength: number;
+    readonly [TypeId]: typeof TypeId;
+    toString(): string;
+    toJSON(): string;
+}
+/**
+ * An IPv4 host address and prefix length.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type Ipv4Interface = IpInterface<NetAddress.Ipv4Address>;
+/**
+ * An IPv6 host address and prefix length.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type Ipv6Interface = IpInterface<NetAddress.Ipv6Address>;
+/**
+ * Companion types for parsing IP interface addresses.
+ *
+ * @since 4.0.0
+ */
+export declare namespace IpInterface {
+    /**
+     * Controls whether the input must contain an explicit prefix. Prefixes are
+     * optional by default and use the address width when omitted.
+     *
+     * @category models
+     * @since 4.0.0
+     */
+    interface ParseOptions {
+        readonly prefix?: "required" | "optional";
+    }
+}
+/**
+ * Returns `true` when a value is an IPv4 interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpv4Interface: (u: unknown) => u is Ipv4Interface;
+/**
+ * Returns `true` when a value is an IPv6 interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpv6Interface: (u: unknown) => u is Ipv6Interface;
+/**
+ * Returns `true` when a value is an IP interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpInterface: (u: unknown) => u is IpInterface;
+/**
+ * Creates an interface address while preserving all address bits.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => Result.Result<IpInterface<A>, NetAddress.NetAddressError>;
+/**
+ * Parses an IPv4 interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to 32. Use `prefix: "required"` to require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const ipv4FromString: (input: string, options?: IpInterface.ParseOptions) => Result.Result<Ipv4Interface, NetAddress.NetAddressError>;
+/**
+ * Parses an IPv6 interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to 128. Use `prefix: "required"` to require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const ipv6FromString: (input: string, options?: IpInterface.ParseOptions) => Result.Result<Ipv6Interface, NetAddress.NetAddressError>;
+/**
+ * Parses an IP interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to the address width. Use `prefix: "required"` to
+ * require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const fromString: (input: string, options?: IpInterface.ParseOptions) => Result.Result<IpInterface, NetAddress.NetAddressError>;
+/**
+ * Creates a trusted interface address, throwing when its prefix length is invalid.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const makeUnsafe: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => IpInterface<A>;
+/**
+ * Parses a trusted interface address, throwing on failure.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const fromStringUnsafe: (input: string, options?: IpInterface.ParseOptions) => IpInterface;
+/**
+ * Formats an interface address using canonical address text and its decimal prefix length.
+ *
+ * @category encoding
+ * @since 4.0.0
+ */
+export declare const format: (self: IpInterface) => string;
+export {};
+//# sourceMappingURL=IpInterface.d.ts.map

package/dist/unstable/net/IpInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpInterface.d.ts","sourceRoot":"","sources":["../../../src/unstable/net/IpInterface.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AACvC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AAGrC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C,QAAA,MAAM,MAAM,EAAG,yBAAkC,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAE,SAAQ,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI;IACpH,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAA;IAC5B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,IAAI,MAAM,CAAA;IAClB,MAAM,IAAI,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;AAE/D;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;AAE/D;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC;;;;;;OAMG;IACH,UAAiB,YAAY;QAC3B,QAAQ,CAAC,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,CAAA;KAC1C;CACF;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,MAAO,OAAO,KAAG,CAAC,IAAI,aACO,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,MAAO,OAAO,KAAG,CAAC,IAAI,aACO,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,aAAa,MAAO,OAAO,KAAG,CAAC,IAAI,WAAqC,CAAA;AA2BrF;;;;;GAKG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WACxC,CAAC,gBACI,MAAM,KACnB,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,eAAe,CAO1D,CAAA;AAuBD;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,UAClB,MAAM,YACH,WAAW,CAAC,YAAY,KACjC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAMvD,CAAA;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,cAAc,UAClB,MAAM,YACH,WAAW,CAAC,YAAY,KACjC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,UAAU,CAAC,eAAe,CAMvD,CAAA;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,UAAU,UACd,MAAM,YACH,WAAW,CAAC,YAAY,KACjC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,eAAe,CAMrD,CAAA;AAEH;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WAAW,CAAC,gBAAgB,MAAM,KAAG,WAAW,CAAC,CAAC,CAC3D,CAAA;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,UAAW,MAAM,YAAY,WAAW,CAAC,YAAY,KAAG,WACtC,CAAA;AAE/C;;;;;GAKG;AACH,eAAO,MAAM,MAAM,SAAU,WAAW,KAAG,MAAqE,CAAA"}

package/dist/unstable/net/IpInterface.js

@@ -0,0 +1,149 @@
+/**
+ * IPv4 and IPv6 interface addresses that preserve host bits alongside a prefix length.
+ *
+ * @since 4.0.0
+ */
+import * as Equal from "../../Equal.js";
+import * as Hash from "../../Hash.js";
+import { NodeInspectSymbol } from "../../Inspectable.js";
+import { hasProperty } from "../../Predicate.js";
+import * as Result from "../../Result.js";
+import * as NetAddress from "./NetAddress.js";
+const TypeId = "~effect/net/IpInterface";
+/**
+ * Returns `true` when a value is an IPv4 interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export const isIpv4Interface = u => isIpInterface(u) && NetAddress.isIpv4Address(u.address);
+/**
+ * Returns `true` when a value is an IPv6 interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export const isIpv6Interface = u => isIpInterface(u) && NetAddress.isIpv6Address(u.address);
+/**
+ * Returns `true` when a value is an IP interface address.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export const isIpInterface = u => hasProperty(u, TypeId);
+const IpInterfaceProto = {
+  _tag: "IpInterface",
+  [TypeId]: TypeId,
+  [Equal.symbol](that) {
+    return isIpInterface(that) && this.prefixLength === that.prefixLength && Equal.equals(this.address, that.address);
+  },
+  [Hash.symbol]() {
+    return Hash.combine(Hash.hash(this.address), Hash.number(this.prefixLength));
+  },
+  toString() {
+    return format(this);
+  },
+  toJSON() {
+    return this.toString();
+  },
+  [NodeInspectSymbol]() {
+    return this.toJSON();
+  }
+};
+const interfaceError = (input, message) => Result.fail(new NetAddress.NetAddressError({
+  input,
+  message
+}));
+/**
+ * Creates an interface address while preserving all address bits.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export const make = (address, prefixLength) => {
+  const max = NetAddress.width(address);
+  if (!Number.isInteger(prefixLength) || prefixLength < 0 || prefixLength > max) {
+    return interfaceError(address, `prefix length must be an integer from 0 through ${max}`);
+  }
+  const self = Object.assign(Object.create(IpInterfaceProto), {
+    address,
+    prefixLength
+  });
+  return Result.succeed(Object.freeze(self));
+};
+const parseAddressWithPrefix = (input, options) => {
+  const slash = input.indexOf("/");
+  if (slash === -1 && options?.prefix !== "required") {
+    return Result.succeed({
+      address: input,
+      prefixLength: undefined
+    });
+  }
+  if (slash <= 0 || slash !== input.lastIndexOf("/") || slash === input.length - 1) {
+    return interfaceError(input, "expected an address and prefix length separated by one slash");
+  }
+  const prefix = input.slice(slash + 1);
+  if (!/^(0|[1-9][0-9]*)$/.test(prefix)) {
+    return interfaceError(input, "prefix length must be an unpadded ASCII decimal integer");
+  }
+  return Result.succeed({
+    address: input.slice(0, slash),
+    prefixLength: Number(prefix)
+  });
+};
+/**
+ * Parses an IPv4 interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to 32. Use `prefix: "required"` to require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export const ipv4FromString = (input, options) => Result.flatMap(parseAddressWithPrefix(input, options), parts => Result.flatMap(NetAddress.ipv4FromString(parts.address), address => make(address, parts.prefixLength ?? NetAddress.width(address))));
+/**
+ * Parses an IPv6 interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to 128. Use `prefix: "required"` to require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export const ipv6FromString = (input, options) => Result.flatMap(parseAddressWithPrefix(input, options), parts => Result.flatMap(NetAddress.ipv6FromString(parts.address), address => make(address, parts.prefixLength ?? NetAddress.width(address))));
+/**
+ * Parses an IP interface address while preserving host bits.
+ *
+ * **Details**
+ *
+ * A missing prefix defaults to the address width. Use `prefix: "required"` to
+ * require one.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export const fromString = (input, options) => Result.flatMap(parseAddressWithPrefix(input, options), parts => Result.flatMap(NetAddress.ipFromString(parts.address), address => make(address, parts.prefixLength ?? NetAddress.width(address))));
+/**
+ * Creates a trusted interface address, throwing when its prefix length is invalid.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const makeUnsafe = (address, prefixLength) => Result.getOrThrow(make(address, prefixLength));
+/**
+ * Parses a trusted interface address, throwing on failure.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const fromStringUnsafe = (input, options) => Result.getOrThrow(fromString(input, options));
+/**
+ * Formats an interface address using canonical address text and its decimal prefix length.
+ *
+ * @category encoding
+ * @since 4.0.0
+ */
+export const format = self => `${NetAddress.formatIp(self.address)}/${self.prefixLength}`;
+//# sourceMappingURL=IpInterface.js.map

package/dist/unstable/net/IpInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpInterface.js","names":[],"sources":["../../../src/unstable/net/IpInterface.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,OAAO,KAAK,KAAK,MAAM,gBAAgB;AACvC,OAAO,KAAK,IAAI,MAAM,eAAe;AACrC,SAAS,iBAAiB,QAAQ,sBAAsB;AACxD,SAAS,WAAW,QAAQ,oBAAoB;AAChD,OAAO,KAAK,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAK,UAAU,MAAM,iBAAiB;AAE7C,MAAM,MAAM,GAAG,yBAAkC;AAmDjD;;;;;;AAMA,OAAO,MAAM,eAAe,GAAI,CAAU,IACxC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;AAEzD;;;;;;AAMA,OAAO,MAAM,eAAe,GAAI,CAAU,IACxC,aAAa,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC;AAEzD;;;;;;AAMA,OAAO,MAAM,aAAa,GAAI,CAAU,IAAuB,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;AAErF,MAAM,gBAAgB,GAAG;EACvB,IAAI,EAAE,aAAa;EACnB,CAAC,MAAM,GAAG,MAAM;EAChB,CAAC,KAAK,CAAC,MAAM,EAAqB,IAAiB;IACjD,OAAO,aAAa,CAAC,IAAI,CAAC,IACxB,IAAI,CAAC,YAAY,KAAK,IAAI,CAAC,YAAY,IACvC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC;EAC5C,CAAC;EACD,CAAC,IAAI,CAAC,MAAM,IAAC;IACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;EAC9E,CAAC;EACD,QAAQ;IACN,OAAO,MAAM,CAAC,IAAI,CAAC;EACrB,CAAC;EACD,MAAM;IACJ,OAAO,IAAI,CAAC,QAAQ,EAAE;EACxB,CAAC;EACD,CAAC,iBAAiB,IAAC;IACjB,OAAO,IAAI,CAAC,MAAM,EAAE;EACtB;CACD;AAED,MAAM,cAAc,GAAG,CAAC,KAAc,EAAE,OAAe,KACrD,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,eAAe,CAAC;EAAE,KAAK;EAAE;AAAO,CAAE,CAAC,CAAC;AAEjE;;;;;;AAMA,OAAO,MAAM,IAAI,GAAG,CAClB,OAAU,EACV,YAAoB,KACyC;EAC7D,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC;EACrC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,IAAI,YAAY,GAAG,GAAG,EAAE;IAC7E,OAAO,cAAc,CAAC,OAAO,EAAE,mDAAmD,GAAG,EAAE,CAAC;EAC1F;EACA,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE;IAAE,OAAO;IAAE;EAAY,CAAE,CAAC;EACtF,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,sBAAsB,GAAG,CAC7B,KAAa,EACb,OAAkC,KAIhC;EACF,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;EAChC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,OAAO,EAAE,MAAM,KAAK,UAAU,EAAE;IAClD,OAAO,MAAM,CAAC,OAAO,CAAC;MAAE,OAAO,EAAE,KAAK;MAAE,YAAY,EAAE;IAAS,CAAE,CAAC;EACpE;EACA,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;IAChF,OAAO,cAAc,CAAC,KAAK,EAAE,8DAA8D,CAAC;EAC9F;EACA,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC;EACrC,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE;IACrC,OAAO,cAAc,CAAC,KAAK,EAAE,yDAAyD,CAAC;EACzF;EACA,OAAO,MAAM,CAAC,OAAO,CAAC;IAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC;IAAE,YAAY,EAAE,MAAM,CAAC,MAAM;EAAC,CAAE,CAAC;AACzF,CAAC;AAED;;;;;;;;;;AAUA,OAAO,MAAM,cAAc,GAAG,CAC5B,KAAa,EACb,OAAkC,KAElC,MAAM,CAAC,OAAO,CACZ,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,EACrC,KAAK,IACJ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,EAAG,OAAO,IAC/D,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CACpE;AAEH;;;;;;;;;;AAUA,OAAO,MAAM,cAAc,GAAG,CAC5B,KAAa,EACb,OAAkC,KAElC,MAAM,CAAC,OAAO,CACZ,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,EACrC,KAAK,IACJ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,OAAO,CAAC,EAAG,OAAO,IAC/D,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CACpE;AAEH;;;;;;;;;;;AAWA,OAAO,MAAM,UAAU,GAAG,CACxB,KAAa,EACb,OAAkC,KAElC,MAAM,CAAC,OAAO,CACZ,sBAAsB,CAAC,KAAK,EAAE,OAAO,CAAC,EACrC,KAAK,IACJ,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,EAAG,OAAO,IAC7D,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,YAAY,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CACpE;AAEH;;;;;;AAMA,OAAO,MAAM,UAAU,GAAG,CAAiC,OAAU,EAAE,YAAoB,KACzF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AAEhD;;;;;;AAMA,OAAO,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAE,OAAkC,KAChF,MAAM,CAAC,UAAU,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;AAE/C;;;;;;AAMA,OAAO,MAAM,MAAM,GAAI,IAAiB,IAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,YAAY,EAAE","ignoreList":[]}

package/dist/unstable/net/IpNetwork.d.ts

@@ -0,0 +1,227 @@
+/**
+ * Pure, canonical IPv4 and IPv6 network prefixes using CIDR notation.
+ *
+ * @since 4.0.0
+ */
+import * as Equal from "../../Equal.ts";
+import * as Hash from "../../Hash.ts";
+import * as Result from "../../Result.ts";
+import * as IpInterface from "./IpInterface.ts";
+import * as NetAddress from "./NetAddress.ts";
+declare const TypeId: "~effect/net/IpNetwork";
+/**
+ * An immutable canonical IP network prefix.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface IpNetwork<out A extends NetAddress.IpAddress = NetAddress.IpAddress> extends Equal.Equal, Hash.Hash {
+    readonly _tag: "IpNetwork";
+    readonly address: A;
+    readonly prefixLength: number;
+    readonly [TypeId]: typeof TypeId;
+    toString(): string;
+    toJSON(): string;
+}
+/**
+ * An immutable canonical IPv4 network prefix.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type Ipv4Network = IpNetwork<NetAddress.Ipv4Address>;
+/**
+ * An immutable canonical IPv6 network prefix.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type Ipv6Network = IpNetwork<NetAddress.Ipv6Address>;
+/**
+ * Returns `true` when a value is an IPv4 network prefix.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpv4Network: (u: unknown) => u is Ipv4Network;
+/**
+ * Returns `true` when a value is an IPv6 network prefix.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpv6Network: (u: unknown) => u is Ipv6Network;
+/**
+ * Returns `true` when a value is an IPv4 or IPv6 network prefix.
+ *
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isIpNetwork: (u: unknown) => u is IpNetwork;
+/**
+ * Creates a network prefix when the address has no host bits set.
+ *
+ * **Gotchas**
+ *
+ * Use {@link fromAddress} when a host address should be truncated to its containing network.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const make: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => Result.Result<IpNetwork<A>, NetAddress.NetAddressError>;
+/**
+ * Creates the canonical network containing an address by clearing its host bits.
+ *
+ * **Gotchas**
+ *
+ * The returned network's address can differ from the input address.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const fromAddress: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => Result.Result<IpNetwork<A>, NetAddress.NetAddressError>;
+/**
+ * Returns the canonical network containing an interface address.
+ *
+ * @category conversions
+ * @since 4.0.0
+ */
+export declare const fromInterface: <A extends NetAddress.IpAddress>(self: IpInterface.IpInterface<A>) => IpNetwork<A>;
+/**
+ * Parses a strict IPv4 network prefix in CIDR notation.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const ipv4FromString: (input: string) => Result.Result<Ipv4Network, NetAddress.NetAddressError>;
+/**
+ * Parses a strict IPv6 network prefix in CIDR notation.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const ipv6FromString: (input: string) => Result.Result<Ipv6Network, NetAddress.NetAddressError>;
+/**
+ * Parses a strict IPv4 or IPv6 network prefix in CIDR notation.
+ *
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const fromString: (input: string) => Result.Result<IpNetwork, NetAddress.NetAddressError>;
+/**
+ * Creates a trusted network prefix, throwing when its address or prefix is invalid.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const makeUnsafe: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => IpNetwork<A>;
+/**
+ * Creates the network containing a trusted address, throwing when its prefix is invalid.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const fromAddressUnsafe: <A extends NetAddress.IpAddress>(address: A, prefixLength: number) => IpNetwork<A>;
+/**
+ * Parses a trusted network prefix in CIDR notation, throwing on failure.
+ *
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const fromStringUnsafe: (input: string) => IpNetwork;
+/**
+ * Formats a network prefix using canonical address text and its decimal prefix length.
+ *
+ * @category encoding
+ * @since 4.0.0
+ */
+export declare const format: (self: IpNetwork) => string;
+/**
+ * Returns the lowest address in a network prefix.
+ *
+ * @category getters
+ * @since 4.0.0
+ */
+export declare const firstAddress: <A extends NetAddress.IpAddress>(self: IpNetwork<A>) => A;
+/**
+ * Returns the numerically greatest address in a network prefix.
+ *
+ * @category getters
+ * @since 4.0.0
+ */
+export declare const lastAddress: <A extends NetAddress.IpAddress>(self: IpNetwork<A>) => A;
+/**
+ * Returns the exact number of addresses in a network prefix.
+ *
+ * @category getters
+ * @since 4.0.0
+ */
+export declare const addressCount: (self: IpNetwork) => bigint;
+/**
+ * Returns `true` when a network prefix contains an IP address.
+ *
+ * @category predicates
+ * @since 4.0.0
+ */
+export declare const contains: {
+    /**
+     * Returns `true` when a network prefix contains an IP address.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (address: NetAddress.IpAddress): (self: IpNetwork) => boolean;
+    /**
+     * Returns `true` when a network prefix contains an IP address.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (self: IpNetwork, address: NetAddress.IpAddress): boolean;
+};
+/**
+ * Returns `true` when a network prefix contains every address in another network prefix.
+ *
+ * @category predicates
+ * @since 4.0.0
+ */
+export declare const containsNetwork: {
+    /**
+     * Returns `true` when a network prefix contains every address in another network prefix.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (other: IpNetwork): (self: IpNetwork) => boolean;
+    /**
+     * Returns `true` when a network prefix contains every address in another network prefix.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (self: IpNetwork, other: IpNetwork): boolean;
+};
+/**
+ * Returns `true` when two network prefixes contain at least one common address.
+ *
+ * @category predicates
+ * @since 4.0.0
+ */
+export declare const overlaps: {
+    /**
+     * Returns `true` when two network prefixes contain at least one common address.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (other: IpNetwork): (self: IpNetwork) => boolean;
+    /**
+     * Returns `true` when two network prefixes contain at least one common address.
+     *
+     * @category predicates
+     * @since 4.0.0
+     */
+    (self: IpNetwork, other: IpNetwork): boolean;
+};
+export {};
+//# sourceMappingURL=IpNetwork.d.ts.map

package/dist/unstable/net/IpNetwork.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IpNetwork.d.ts","sourceRoot":"","sources":["../../../src/unstable/net/IpNetwork.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAEvC,OAAO,KAAK,IAAI,MAAM,eAAe,CAAA;AAGrC,OAAO,KAAK,MAAM,MAAM,iBAAiB,CAAA;AACzC,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAC/C,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C,QAAA,MAAM,MAAM,EAAG,uBAAgC,CAAA;AAE/C;;;;;GAKG;AACH,MAAM,WAAW,SAAS,CAAC,GAAG,CAAC,CAAC,SAAS,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAE,SAAQ,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI;IAClH,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACnB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAC7B,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;IAChC,QAAQ,IAAI,MAAM,CAAA;IAClB,MAAM,IAAI,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAA;AAE3D;;;;;GAKG;AACH,eAAO,MAAM,aAAa,MAAO,OAAO,KAAG,CAAC,IAAI,WAAoE,CAAA;AAEpH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,MAAO,OAAO,KAAG,CAAC,IAAI,WAAoE,CAAA;AAEpH;;;;;GAKG;AACH,eAAO,MAAM,WAAW,MAAO,OAAO,KAAG,CAAC,IAAI,SAAmC,CAAA;AAkDjF;;;;;;;;;GASG;AACH,eAAO,MAAM,IAAI,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WACxC,CAAC,gBACI,MAAM,KACnB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,eAAe,CAWxD,CAAA;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WAC/C,CAAC,gBACI,MAAM,KACnB,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,eAAe,CAKxD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,QAAQ,WAAW,CAAC,WAAW,CAAC,CAAC,CAAC,KAAG,SAAS,CAAC,CAAC,CACxD,CAAA;AAEpD;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,eAAe,CAKnG,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,cAAc,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,eAAe,CAKnG,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,eAAe,CAK7F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WAAW,CAAC,gBAAgB,MAAM,KAAG,SAAS,CAAC,CAAC,CACzD,CAAA;AAEhD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,WAAW,CAAC,gBAAgB,MAAM,KAAG,SAAS,CAAC,CAAC,CACzD,CAAA;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,UAAW,MAAM,KAAG,SAAiD,CAAA;AAElG;;;;;GAKG;AACH,eAAO,MAAM,MAAM,SAAU,SAAS,KAAG,MAAqE,CAAA;AAE9G;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,QAAQ,SAAS,CAAC,CAAC,CAAC,KAAG,CAAiB,CAAA;AAEnG;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,CAAC,SAAS,UAAU,CAAC,SAAS,QAAQ,SAAS,CAAC,CAAC,CAAC,KAAG,CAIhF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,YAAY,SAAU,SAAS,KAAG,MAC0B,CAAA;AASzE;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,OAAO,EAAE,UAAU,CAAC,SAAS,GAAG,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAA;IAC7D;;;;;OAKG;IACH,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,SAAS,GAAG,OAAO,CAAA;CACjC,CAAA;AAE1B;;;;;GAKG;AACH,eAAO,MAAM,eAAe,EAAE;IAC5B;;;;;OAKG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAA;IAChD;;;;;OAKG;IACH,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAA;CAG5C,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,KAAK,EAAE,SAAS,GAAG,CAAC,IAAI,EAAE,SAAS,KAAK,OAAO,CAAA;IAChD;;;;;OAKG;IACH,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAA;CAK5C,CAAA"}