Expand description
Break a string into a set of directory-object Items.
This module defines Item, which represents a basic entry in a directory document, and NetDocReader, which is used to break a string into Items.
Re-exportsยง
use crate::parse::keyword::Keyword;๐use crate::types::misc::FromBytes;๐use crate::Error;๐use crate::NetdocErrorKind as EK;๐use crate::Pos;๐use crate::Result;๐use base64ct::Base64;๐use base64ct::Encoding;๐use itertools::Itertools;๐use std::cell::Ref;๐use std::cell::RefCell;๐use std::iter::Peekable;๐use std::str::FromStr;๐use tor_error::internal;๐
Modulesยง
- object ๐
- Useful constants for netdoc object syntax
Structsยง
- Item ๐
- A single part of a directory object.
- Maybe
Item ๐ - Represents an Item that might not be present, whose arguments we want to inspect. If the Item is there, this acts like a proxy to the item; otherwise, it treats the item as having no arguments.
- NetDoc
Reader ๐ - A peekable cursor into a string that returns Items one by one.
- NetDoc
Reader ๐Base - A cursor into a string that returns Items one by one.
- Object ๐
- A tagged object that is part of a directory Item.
Traitsยง
- Item
Result ๐ - Extension trait for
Result<Item>โ makes it convenient to implement PauseAt predicates
Functionsยง
- b64check ๐
- Check that all the characters in
sare valid base64. - base64_
decode_ ๐multiline - Helper: as base64::decode(), but allows newlines in the middle of the encoded object.
- is_sp ๐
- Return true iff a given character is โspaceโ according to the rules of dir-spec.txt
- keyword_
ok ๐ - Return true iff โsโ is a valid keyword or annotation.
- tag_
keywords_ ๐ok - Return true iff โsโ is a valid keywords string for a BEGIN/END tag.
- validate_
utf_ ๐8_ rules - Check additional UTF-8 rules that the netdoc metaformat imposes on our documents.