You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Arcus
2
2
3
-
Arcus is a C# manipulation library for calculating, parsing, formatting, converting, and comparing both IPv4 and Pv6 addresses and subnets. It accounts for 128-bit numbers on 32-bit platforms.
3
+
Arcus is a C# manipulation library for calculating, parsing, formatting, converting, and comparing both IPv4 and IPv6 addresses and subnets. It accounts for 128-bit numbers on 32-bit platforms.
4
4
5
5
## Getting Started
6
6
@@ -18,15 +18,15 @@ At its heart Arcus is split amongst five separate interdependent units. *Types*,
18
18
19
19
#### `Subnet`
20
20
21
-
An IPv4 or IPv6 subnetwork representation - the work horse and original reason for the Arcus library. Outside the concept of the `Subnet` object, most everything else in Arcus is auxiliary and exists only in support of making this once facet work. That’s not to say that the remaining pieces of the Arcus library aren’t useful, on the contrary their utility can benefit a developer greatly. That said, once the `Subnet` is mastered the rest of Arcus should follow through nicely.
21
+
An IPv4 or IPv6 subnetwork representation - the work horse and original reason for the Arcus library. Outside the concept of the `Subnet` object, most everything else in Arcus is auxiliary and exists only in support of making this once facet work. That’s not to say that the remaining pieces of the Arcus library aren’t useful, on the contrary their utility can benefit a developer greatly. That said, once the `Subnet` is mastered the rest of Arcus should follow through nicely.
22
22
23
23
A `Subnet` may be instantiated in several ways:
24
24
25
25
To the most common ways to create a subnet is to construct it via a high and low `IPAddress` call the constructor `Subnet(IPAddress primary, IPAddress secondary)` This construct the smallest possible subnet that would contain both IP addresses typically the address specified are the Network and Broadcast addresses (lower and higher bounds) but this is not necessary. Addresses *MUST* be the same address family (either Internetwork or InternetworkV6)
26
26
27
27
It is also possible to create a `Subnet` from an `IPAddress` and an `integer` based *route prefix*. Eg: `Subnet(IPAddress ipAddress, int routingPrefix)`
28
28
29
-
Likewise it may be desired to statically parse a subnet string with `Subnet. Parse(string input)` or it’s safe equivalent of ` bool Subnet.TryParse(string input, out Subnet subnet)`. For example, one could safely parse the `string` "192.168.1.0/16" via
29
+
Likewise it may be desired to statically parse a subnet string with `Subnet. Parse(string input)` or it’s safe equivalent of ` bool Subnet.TryParse(string input, out Subnet subnet)`. For example, one could safely parse the `string` "192.168.1.0/16" via
30
30
```
31
31
Subnet subnet;
32
32
var success = Subnet.TryParse("192.168.1.0/16", out subnet)
@@ -237,4 +237,4 @@ distributed under the License is distributed on an "AS IS" BASIS,
237
237
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
238
238
See the License for the specific language governing permissions and
0 commit comments