Struct NotPresentEachValue 

#[non_exhaustive]
pub struct NotPresentEachValue;

An individual value that is not present - placeholder type

This is the “single” item type for encoding multiplicity (for Items, Arguments or Objects), for NotPresent.

It should not be used directly.

During parsing, each “not present” item is ignored, but the multiplicity arrangements involve parsing each value and then passing the item value to ItemSetMethods::accumulate where (for NotPresentEachValue) it is discarded. Therefore this type must be inhabited; the item parser discards the unparsed item.

During parsing of arguments, parsing is driven by [our ArgumentSetMethods::parse_with][P2MultiplicitySelector::<NotPresent>::parse_with) which doesn't need to call any parser. So the [ItemArgumentParseable`] implementation always throws an error.

During parsing of objects, rejection is done by NotPresentEachValue::check_label (and from_bytes).

For encoding, there is only one multiplicity system which will never call any encoding function, so the encoding functions all throw Bug.

This type has a similar role to IgnoredItemOrObjectValue, but NotPresentEachValue is different in detail, and (unlike Ignored) must support arguments, not just items and objects.

Trait Implementations

impl Clone for NotPresentEachValue

fn clone(&self) -> NotPresentEachValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotPresentEachValue

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

Formats the value using the given formatter.

impl ItemArgument for NotPresentEachValue

fn write_arg_onto(&self, _out: &mut ItemEncoder<'_>) -> Result<(), Bug>

Format as a string suitable for including as a netdoc keyword line argument

impl ItemArgumentParseable for NotPresentEachValue

fn from_args<'s>(_: &mut ArgumentStream<'s>) -> Result<Self, ArgumentError>

Parse the argument

impl ItemObjectEncodable for NotPresentEachValue

fn label(&self) -> &str

The label (keyword(s) in BEGIN and END)

fn write_object_onto(&self, _b: &mut Vec<u8>) -> Result<(), Bug>

Represent the actual value as bytes.

impl ItemObjectParseable for NotPresentEachValue

fn check_label(_label: &str) -> Result<(), EP>

Check that the Label is right

fn from_bytes(_input: &[u8]) -> Result<Self, EP>

Convert the bytes of the Object (which was present) into the actual value

impl ItemValueEncodable for NotPresentEachValue

fn write_item_value_onto(&self, _out: ItemEncoder<'_>) -> Result<(), Bug>

Write the item’s arguments, and any object, onto out

impl ItemValueParseable for NotPresentEachValue

fn from_unparsed<'s>(input: UnparsedItem<'s>) -> Result<Self, EP>

Parse the item’s value

impl NetdocParseableFields for NotPresentEachValue

type Accumulator = NotPresentEachValueNetdocParseAccumulator

The partially-parsed set of items.

fn is_item_keyword(kw: KeywordRef<'_>) -> bool

Is this one of the keywords in this struct

fn accumulate_item( acc: &mut Self::Accumulator, item: UnparsedItem<'_>, ) -> Result<(), ErrorProblem>

Accumulate an item in this struct

fn finish( acc: Self::Accumulator, items: &ItemStream<'_>, ) -> Result<Self, ErrorProblem>

Finish