Struct NetdocEncoder

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

Available on crate feature hs-service only.

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

Implementations

impl NetdocEncoder

pub(crate) fn new() -> Self

Start encoding a document

pub(crate) fn item(&mut self, keyword: impl Keyword) -> 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(crate) 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(crate) fn cursor(&self) -> Cursor

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

pub(crate) 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(crate) 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.