Module encode 

Support for encoding the network document meta-format

Implements writing documents according to dir-spec.txt. section 1.2 and 1.3.

This facility processes output that complies with the meta-document format, (dir-spec.txt section 1.2) - unless raw methods are called with improper input.

However, no checks are done on keyword presence/absence, multiplicity, or ordering, so the output may not necessarily conform to the format of the particular intended document. It is the caller’s responsibility to call .item() in the right order, with the right keywords and arguments.

Modules

derive 🔒

Deriving NetdocEncodable

impls 🔒

Implementations of our useful traits, on external and parsing-mode types

multiplicity 🔒

Multiplicity for encoding netdoc elements, via ad-hoc deref specialisation.

Macros

item_value_encodable_for_tuple 🔒

implement ItemValueEncodable for a particular tuple size

Structs

Cursor

Position within a (perhaps partially-) built document

ItemEncoder

Encoder for an individual item within a being-built document

NetdocEncoder

Encoder, representing a partially-built document.

Traits

EncodeOrd

Ordering, to be used when encoding network documents

ItemArgument

Types that can be added as argument(s) to item keyword lines

ItemObjectEncodable

An Object value that be encoded into a netdoc

ItemValueEncodable

Items that can be encoded in network documents

NetdocBuilder

Builders for network documents.

NetdocEncodable

Documents (or sub-documents) that can be encoded in the netdoc metaformat

NetdocEncodableFields

Collections of fields that can be encoded in the netdoc metaformat