Struct DocumentationDocument 

pub struct DocumentationDocument {
    pub records: Vec<DocumentRecord>,
    pub ownership_rules: Vec<OwnershipRule>,
    pub warnings: Vec<String>,
    pub incomplete: bool,
}

Complete bounded output for one documentation source.

Fields

records: Vec<DocumentRecord>

Extracted documentation records.

ownership_rules: Vec<OwnershipRule>

CODEOWNERS rules in precedence-preserving file order.

warnings: Vec<String>

Bounded, non-sensitive document-level warnings.

incomplete: bool

Whether any output was omitted, redacted, malformed, or truncated.

Trait Implementations

impl Clone for DocumentationDocument

fn clone(&self) -> DocumentationDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentationDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentationDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DocumentationDocument

impl PartialEq for DocumentationDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for DocumentationDocument

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DocumentationDocument