Class CountryCode

Namespace

Trellis.Primitives

Assembly

Trellis.Primitives.dll

ISO 3166-1 alpha-2 country code value object.

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

Inheritance

object

ValueObject

ScalarValueObject<CountryCode, string>

CountryCode

Implements

IComparable<ValueObject>

IEquatable<ValueObject>

IConvertible

IScalarValue<CountryCode, string>

IParsable<CountryCode>

Inherited Members

ScalarValueObject<CountryCode, string>.Value

ScalarValueObject<CountryCode, string>.GetEqualityComponents()

ScalarValueObject<CountryCode, string>.ToString()

ScalarValueObject<CountryCode, string>.Create(string)

ScalarValueObject<CountryCode, string>.GetTypeCode()

ScalarValueObject<CountryCode, string>.ToBoolean(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToByte(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToChar(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToDateTime(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToDecimal(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToDouble(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToInt16(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToInt32(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToInt64(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToSByte(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToSingle(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToString(IFormatProvider)

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

ScalarValueObject<CountryCode, string>.ToUInt16(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToUInt32(IFormatProvider)

ScalarValueObject<CountryCode, string>.ToUInt64(IFormatProvider)

ValueObject.GetEqualityComponents()

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)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Error)

Remarks

Validation Rules (Opinionated):

• Exactly 2 letters (ISO 3166-1 alpha-2 format)
• Normalized to uppercase

If these rules don't fit your domain (e.g., you need alpha-3 or numeric codes), create your own CountryCode value object using the ScalarValueObject<TSelf, T> base class.

Methods

Parse(string?, IFormatProvider?)

Parses a country code.

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

Parameters

s string

provider IFormatProvider

Returns

CountryCode

TryCreate(string?, string?)

Attempts to create a country code.

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

Parameters

value string

fieldName string

Returns

Result<CountryCode>

TryParse(string?, IFormatProvider?, out CountryCode)

Tries to parse a country code.

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

Parameters

s string

provider IFormatProvider

result CountryCode

Returns

bool