Class IpAddress

Namespace

Trellis.Primitives

Assembly

Trellis.Primitives.dll

Represents an IP address (IPv4 or IPv6) as a value object.

[JsonConverter(typeof(ParsableJsonConverter<IpAddress>))]
public class IpAddress : ScalarValueObject<IpAddress, string>, IComparable<ValueObject>, IComparable, IEquatable<ValueObject>, IConvertible, IFormattable, IScalarValue<IpAddress, string>, IParsable<IpAddress>

Inheritance

object

ValueObject

ScalarValueObject<IpAddress, string>

IpAddress

Implements

IComparable<ValueObject>

IComparable

IEquatable<ValueObject>

IConvertible

IFormattable

IScalarValue<IpAddress, string>

IParsable<IpAddress>

Inherited Members

ScalarValueObject<IpAddress, string>.Value

ScalarValueObject<IpAddress, string>.GetEqualityComponents(ref EqualityComponents)

ScalarValueObject<IpAddress, string>.ToString()

ScalarValueObject<IpAddress, string>.Create(string)

ScalarValueObject<IpAddress, string>.GetTypeCode()

ScalarValueObject<IpAddress, string>.ToBoolean(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToByte(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToChar(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToDateTime(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToDecimal(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToDouble(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToInt16(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToInt32(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToInt64(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToSByte(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToSingle(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToString(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToString(string, IFormatProvider)

ScalarValueObject<IpAddress, string>.ToType(Type, IFormatProvider)

ScalarValueObject<IpAddress, string>.ToUInt16(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToUInt32(IFormatProvider)

ScalarValueObject<IpAddress, string>.ToUInt64(IFormatProvider)

ValueObject.GetEqualityComponents(ref EqualityComponents)

ValueObject.MaybeComponent<T>(Maybe<T>)

ValueObject.Equals(object)

ValueObject.Equals(ValueObject)

ValueObject.GetHashCode()

ValueObject.CompareTo(ValueObject)

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Remarks

Validates using TryParse(string, out IPAddress). Provides parsing and JSON serialization support.

Methods

Parse(string?, IFormatProvider?)

Parses an IP address.

public static IpAddress Parse(string? s, IFormatProvider? provider)

Parameters

s string

provider IFormatProvider

Returns

IpAddress

ToIPAddress()

Gets the underlying IPAddress.

public IPAddress ToIPAddress()

Returns

IPAddress

TryCreate(string?, string?)

Attempts to create an IP address. If fieldName is not provided, validation errors use "ipAddress" as the field name.

public static Result<IpAddress> TryCreate(string? value, string? fieldName = null)

Parameters

value string

The string value to validate.

fieldName string

Optional field name for validation error messages. If not provided, defaults to "ipAddress".

Returns

Result<IpAddress>

Success with the IpAddress if valid; Failure with Error.InvalidInput otherwise.

TryParse(string?, IFormatProvider?, out IpAddress)

Tries to parse an IP address.

public static bool TryParse(string? s, IFormatProvider? provider, out IpAddress result)

Parameters

s string

provider IFormatProvider

result IpAddress

Returns

bool