Struct Document 

pub struct Document { /* private fields */ }

An index document: an ordered list of fields.

Order follows the on-wire layout. Documents average ~10 fields, so the linear-scan find helper is fine.

Implementations

impl Document

pub fn new(fields: Vec<Field>) -> Self

Construct a Document from an ordered list of fields.

pub fn fields(&self) -> &[Field]

All fields in on-wire order.

pub fn find(&self, key: &str) -> Option<&str>

Return the value of the first field whose name equals key.

pub fn has(&self, key: &str) -> bool

Return true if any field’s name equals key.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Document> for Record

fn try_from(doc: &Document) -> Result<Self, Self::Error>

Classify a document into a Record.

Rules, checked in priority order:

1. DESCRIPTOR field → Descriptor
2. allGroups field → AllGroups
3. rootGroups field → RootGroups
4. u field → ArtifactAdd(parse_uinfo(u))
5. del field → ArtifactRemove(parse_uinfo(del))
6. otherwise → Unknown

Errors

Returns ParseError::MalformedUinfo when an add or remove record contains a UINFO string that cannot be parsed. Structural documents (descriptor, group lists) never fail.

type Error = ParseError

The type returned in the event of a conversion error.

impl Eq for Document

impl StructuralPartialEq for Document