Struct NetdocEncoder 

pub struct NetdocEncoder {
    built: Result<String, Bug>,
}

Encoder, representing a partially-built document.

For example usage, see the tests in this module, or a descriptor building function in tor-netdoc (such as hsdesc::build::inner::HsDescInner::build_sign).

Fields

built: Result<String, Bug>

The being-built document, with everything accumulated so far

If an ItemEncoder exists, it will add a newline when it’s dropped.

Err means bad values passed to some builder function. Such errors are accumulated here for the benefit of handwritten document encoders.

Implementations

impl NetdocEncoder

pub fn new() -> Self

Start encoding a document

pub fn item(&mut self, keyword: impl KeywordEncodable) -> ItemEncoder<'_>

Adds an item to the being-built document

The item can be further extended with arguments or an object, using the returned ItemEncoder.

fn raw(&mut self, s: &dyn Display)

Internal name for push_raw_string()

fn write_with(&mut self, f: impl FnOnce(&mut String) -> Result<(), Bug>)

Extend the being-built document with a fallible function f

Doesn’t call f if the building has already failed, and handles the error if f fails.

pub fn push_raw_string(&mut self, s: &dyn Display)

Adds raw text to the being-built document

s is added as raw text, after the newline ending the previous item. If item is subsequently called, the start of that item will immediately follow s.

It is the responsibility of the caller to obey the metadocument syntax. In particular, s should end with a newline. No checks are performed. Incorrect use might lead to malformed documents, or later errors.

pub fn cursor(&self) -> Cursor

Return a cursor, pointing to just after the last item (if any)

pub fn slice(&self, begin: Cursor, end: Cursor) -> Result<&str, Bug>

Obtain the text of a section of the document

Useful for making a signature.

pub fn text_sofar(&self) -> Result<&str, Bug>

Obtain the document so far in textual form

pub fn finish(self) -> Result<String, Bug>

Build the document into textual form

Trait Implementations

impl Clone for NetdocEncoder

fn clone(&self) -> NetdocEncoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NetdocEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NetdocEncoder

fn default() -> Self

Returns the “default value” for a type.