pont/spec

Types

Format

pub type Format {
  DateFormat
  DatetimeFormat
  I32Format
  I64Format
  F32Format
  F64Format
  PasswordFormat
  ByteFormat
  BinaryFormat
  CustomFormat(format: String)
}

Constructors

```
DateFormat
```
```
DatetimeFormat
```
```
I32Format
```
```
I64Format
```
```
F32Format
```
```
F64Format
```
```
PasswordFormat
```
```
ByteFormat
```
```
BinaryFormat
```
```
CustomFormat(format: String)
```

ObjectField

</>

pub type ObjectField {
  ObjectField(name: String, spec: Spec, required: Bool)
}

Constructors

ObjectField(name: String, spec: Spec, required: Bool)

Spec

</>

pub type Spec {
  String(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    enum_variants: List(String),
    pattern: option.Option(String),
  )
  Integer(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    min: option.Option(Int),
    max: option.Option(Int),
  )
  Float(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    min: option.Option(Float),
    max: option.Option(Float),
  )
  Boolean(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
  )
  Null(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
  )
  Array(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    of: Spec,
  )
  Option(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    of: Spec,
  )
  Object(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    fields: List(ObjectField),
  )
  Union(
    format: option.Option(Format),
    default: option.Option(value.Value),
    example: List(value.Value),
    variants: List(Spec),
  )
}

Constructors

String(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  enum_variants: List(String),
  pattern: option.Option(String),
)

Integer(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  min: option.Option(Int),
  max: option.Option(Int),
)

Float(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  min: option.Option(Float),
  max: option.Option(Float),
)

Boolean(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
)

Null(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
)

Array(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  of: Spec,
)

Option(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  of: Spec,
)

Object(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  fields: List(ObjectField),
)

Union(
  format: option.Option(Format),
  default: option.Option(value.Value),
  example: List(value.Value),
  variants: List(Spec),
)

Values

array

</>

pub fn array(of: Spec) -> Spec

bool

</>

pub fn bool() -> Spec

float

</>

pub fn float() -> Spec

float_within

</>

pub fn float_within(min: Float, max: Float) -> Spec

int

</>

pub fn int() -> Spec

int_within

</>

pub fn int_within(min: Int, max: Int) -> Spec

null

</>

pub fn null() -> Spec

object

</>

pub fn object(fields: List(ObjectField)) -> Spec

option

</>

pub fn option(of: Spec) -> Spec

string

</>

pub fn string() -> Spec

string_enum

</>

pub fn string_enum(variants: List(String)) -> Spec

union

</>

pub fn union(variants: List(Spec)) -> Spec

with_format

</>

pub fn with_format(spec: Spec, format: Format) -> Spec