Struct ItemEncoder

pub(crate) struct ItemEncoder<'n> {
    doc: &'n mut NetdocEncoder,
}

Available on crate feature hs-service only.

Encoder for an individual item within a being-built document

Returned by NetdocEncoder::item().

Fields

doc: &'n mut NetdocEncoder

The document including the partial item that we’re building

We will always add a newline when we’re dropped

Implementations

impl<'n> ItemEncoder<'n>

pub(crate) fn arg(self, arg: &dyn ItemArgument) -> Self

Add a single argument.

If the argument is not in the correct syntax, a Bug error will be reported (later).

pub(crate) fn add_arg(&mut self, arg: &dyn ItemArgument)

Add a single argument, to a borrowed ItemEncoder

If the argument is not in the correct syntax, a Bug error will be reported (later).

pub(crate) fn args_raw_string(self, args: &dyn Display) -> Self

Add zero or more arguments, supplied as a single string.

args should zero or more valid argument strings, separated by (single) spaces. This is not (properly) checked. Incorrect use might lead to malformed documents, or later errors.

fn args_raw_nonempty(&mut self, args: &dyn Display)

Add one or more arguments, supplied as a single string, without any checking

pub(crate) fn object(self, keywords: &str, data: impl WriteableOnce)

Add an object to the item

Checks that keywords is in the correct syntax. Doesn’t check that it makes semantic sense for the position of the document. data will be PEM (base64) encoded.

Trait Implementations

impl<'n> Debug for ItemEncoder<'n>

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

Formats the value using the given formatter.

impl Drop for ItemEncoder<'_>

fn drop(&mut self)

Executes the destructor for this type.