interface Decoder
pub interface DecoderThe reading side of a format, pull-based: a conformance asks for the form it expects, and the
format answers it or throws TypeMismatch. The containers: beginSeq() answers the count
where the format knows it, seqHasNext() whether an element follows — which is how a format
that does not know the count ends a sequence —; beginMap()/mapHasNext() the same, a key
and a value read in turn; beginStruct(name, fields) positions on a struct, structField(name)
on one of its fields — false where the data has none —, endStruct(denyUnknown) leaves it
and, where asked, refuses a field the data has and the type has not; beginVariant(enum, variants) answers the index of the variant the data holds (or throws UnknownVariant),
variantHasPayload() whether one follows. A format without names in its data (one that reads
structs in field order) answers structField by position. A read that mismatches leaves the
value where it was: the next ask sees it again, which is how Value reads whatever comes.
Methods
mut fn isNull(): bool throws DecodeErrorReturns whether the next value is null, without taking it.
mut fn decodeNull(): void throws DecodeErrormut fn decodeBool(): bool throws DecodeErrormut fn decodeInt(): int throws DecodeErrormut fn decodeUint(): uint throws DecodeErrormut fn decodeFloat(): float throws DecodeErrormut fn decodeString(): string throws DecodeErrormut fn decodeBytes(): uint8[] throws DecodeErrormut fn beginSeq(): ?int throws DecodeErrorfn seqHasNext(): bool throws DecodeErrormut fn endSeq(): void throws DecodeErrormut fn beginMap(): ?int throws DecodeErrorfn mapHasNext(): bool throws DecodeErrormut fn endMap(): void throws DecodeErrormut fn beginStruct(name: string, fields: string[]): void throws DecodeErrormut fn structField(name: string): bool throws DecodeErrormut fn endStruct(denyUnknown: bool): void throws DecodeErrormut fn beginVariant(enumName: string, variants: string[]): int throws DecodeErrorfn variantHasPayload(): bool throws DecodeErrormut fn endVariant(): void throws DecodeErrorfn path(): stringReturns where the decoder stands, for an error: "" at the root, users[0].mail below.