Class StringInfo
This class contains metadata about a Primitively IString type.
Inherited Members
Namespace: Primitively
Assembly: Primitively.Abstractions.dll
Syntax
public record StringInfo : PrimitiveInfo, IEquatable<PrimitiveInfo>, IEquatable<StringInfo>
Constructors
StringInfo(Type, string?, Func<string?, IPrimitive>, string?, string?, int, int)
This class contains metadata about a Primitively IString type.
Declaration
public StringInfo(Type Type, string? Example, Func<string?, IPrimitive> CreateFrom, string? Format, string? Pattern, int MinLength, int MaxLength)
Parameters
Type | Name | Description |
---|---|---|
Type | Type | The Primitively type. |
string | Example | An optional example of the string. |
Func<string, IPrimitive> | CreateFrom | A function that creates an instance of the Primitively type from a string. |
string | Format | An optional format of the string. |
string | Pattern | An optional regular expression pattern used to validate the encapsulated value. |
int | MinLength | The minimum length of the string representation of the encapsulated primitive value. |
int | MaxLength | The maximum length of the string representation of the encapsulated primitive value. |
Properties
Format
An optional format of the string.
Declaration
public string? Format { get; init; }
Property Value
Type | Description |
---|---|
string |
MaxLength
The maximum length of the string representation of the encapsulated primitive value.
Declaration
public int MaxLength { get; init; }
Property Value
Type | Description |
---|---|
int |
MinLength
The minimum length of the string representation of the encapsulated primitive value.
Declaration
public int MinLength { get; init; }
Property Value
Type | Description |
---|---|
int |
Pattern
An optional regular expression pattern used to validate the encapsulated value.
Declaration
public string? Pattern { get; init; }
Property Value
Type | Description |
---|---|
string |