silk.schema.issue.

When to use#

Match on Issue when a codec, a check, or a format reader rejects input. Read SchemaError from silk.schema.json.SchemaJson.decode to show a person what failed and where, such as port: between 1 and 65535.

Details#

An Issue is a small copyable value: a IssueReason, one line of static text that names what was expected, and the byte offset of the problem when the format knows it. A SchemaError adds the path from the root value to the part that failed.

Import as Issue with import silk.schema.issue { Issue }.

Public declarations: 4.

IssueReason#

pub enum IssueReason

Why a value could not be read, written, or accepted.

InvalidType#

InvalidType

The input holds another kind of value, such as text where a number was expected.

InvalidValue#

InvalidValue

The input holds the right kind of value, but not one the type accepts, such as 300 for a u8.

MissingKey#

MissingKey

A required key is absent.

InvalidSyntax#

InvalidSyntax

The input is not well formed, such as JSON without a closing quote.

CheckFailed#

CheckFailed

A check of the value failed.

UnknownVariant#

UnknownVariant

The text names no variant of the union.

Issue#

pub struct Issue

One problem found while reading, writing, or checking a value.

Details#

expected is one line of static text that says what the schema wanted, such as "a number" or "between 1 and 65535". offset is the byte offset of the problem in the input, when the format knows it.

Field reason#

pub reason: IssueReason

Why the value was rejected.

Field expected#

pub expected: string<'static>

What the schema expected, as one line of text for a person.

Field offset#

pub offset: Option<usize>

The byte offset of the problem in the input, if known.

Implementation Copy for Issue#

impl Copy for Issue

Implementation Issue#

impl Issue

Associated function make#

pub fn make(reason: IssueReason, expected: string<'static>) -> Issue

Returns an issue with reason and expected, and no offset.

Associated function at#

pub fn at(reason: IssueReason, expected: string<'static>, offset: usize) -> Issue

Returns an issue at byte offset of the input.

Associated function invalidType#

pub fn invalidType(expected: string<'static>) -> Issue

Returns an issue for input that holds another kind of value than expected.

Associated function invalidValue#

pub fn invalidValue(expected: string<'static>) -> Issue

Returns an issue for a value of the right kind that the type does not accept.

Associated function missingKey#

pub fn missingKey() -> Issue

Returns an issue for a required key that is absent.

Associated function checkFailed#

pub fn checkFailed(expected: string<'static>) -> Issue

Returns an issue for a check that failed. expected is the check's message.

Implementation Debug for Issue#

impl Debug for Issue

Operation debug#

effect fn debug(self: &Self, formatter: &mut Formatter) -> () ! WriterError ? &mut Writer

Writes the fields, as Issue { reason: ..., expected: ..., offset: ... }.

Implementation Debug for IssueReason#

impl Debug for IssueReason

Operation debug#

effect fn debug(self: &Self, formatter: &mut Formatter) -> () ! WriterError ? &mut Writer

Writes the name of the reason, such as MissingKey.

SchemaError#

pub struct SchemaError

A rejected value: the problem, and the path from the root value to the part that failed.

Details#

path names struct fields by their Silk names and list elements by their index, as settings.ports[2]. It is empty when the root value itself failed.

Field path#

pub path: String

The path from the root value to the part that failed, such as settings.ports[2].

Field issue#

pub issue: Issue

The problem.

Implementation Debug for SchemaError#

impl Debug for SchemaError

Operation debug#

effect fn debug(self: &Self, formatter: &mut Formatter) -> () ! WriterError ? &mut Writer

Writes the fields, as SchemaError { path: ..., issue: ... }.

SchemaErrors#

pub struct SchemaErrors

Every problem found while reading one value, in the order they were found.

Details#

silk.schema.json.SchemaJson.decodeAll reports it. Every failed check is listed, and reading stops at the first value that does not have the expected shape, which is listed last.

Field errors#

pub errors: List<SchemaError>

The problems, never empty.

Implementation Debug for SchemaErrors#

impl Debug for SchemaErrors

Operation debug#

effect fn debug(self: &Self, formatter: &mut Formatter) -> () ! WriterError ? &mut Writer

Writes the problems, as SchemaErrors { errors: [...] }.

Category: Data formats.

Profiles: aarch64-apple-darwin, aarch64-unknown-linux-gnu, aarch64-unknown-linux-gnu-no-libc, x86_64-unknown-linux-gnu, x86_64-unknown-linux-gnu-no-libc, wasm32-unknown-unknown, wasm32-wasip1, wasm32-wasip2, x86_64-pc-windows-msvc, wasm64-unknown-unknown.