Struct gedcomx::Document [−][src]
#[non_exhaustive]pub struct Document { pub id: Option<Id>, pub lang: Option<Lang>, pub sources: Vec<SourceReference>, pub analysis: Option<ResourceReference>, pub notes: Vec<Note>, pub confidence: Option<ConfidenceLevel>, pub attribution: Option<Attribution>, pub document_type: Option<DocumentType>, pub extracted: Option<bool>, pub text_type: Option<TextType>, pub text: String, }
Expand description
The base conceptual model for genealogical data that are managed as textual documents.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.id: Option<Id>
An identifier for the conclusion data. The id is to be used as a “fragment identifier” as defined by RFC 3986, Section 3.5.
lang: Option<Lang>
The locale identifier for the conclusion.
sources: Vec<SourceReference>
The list of references to the sources of related to this conclusion.
Note that the sources referenced from conclusions are also considered
to be sources of the entities that contain them. For example, a source
associated with the Name
of a Person
is also source for the
Person
.
analysis: Option<ResourceReference>
A reference to the analysis document explaining the analysis that went into this conclusion. If provided, MUST resolve to an instance of Document of type Analysis.
notes: Vec<Note>
A list of notes about this conclusion.
confidence: Option<ConfidenceLevel>
The level of confidence the contributor has about the data.
attribution: Option<Attribution>
The attribution of this conclusion. If not provided, the attribution of the containing data set (e.g. file) of the conclusion is assumed.
document_type: Option<DocumentType>
Enumerated value identifying the type of the document.
extracted: Option<bool>
Whether this document is to be constrained as an extracted conclusion, meaning it captures information extracted from a single source.
text_type: Option<TextType>
The type of text in the text
property.
If no value is provided, “plain” is assumed.
text: String
The text of the document.
Implementations
pub fn new(
id: Option<Id>,
lang: Option<Lang>,
sources: Vec<SourceReference>,
analysis: Option<ResourceReference>,
notes: Vec<Note>,
confidence: Option<ConfidenceLevel>,
attribution: Option<Attribution>,
document_type: Option<DocumentType>,
extracted: Option<bool>,
text_type: Option<TextType>,
text: String
) -> Self
Trait Implementations
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
fn serialize_attributes(
&self,
source_attributes: Vec<OwnedAttribute>,
source_namespace: Namespace
) -> Result<(Vec<OwnedAttribute>, Namespace), String>
Auto Trait Implementations
impl RefUnwindSafe for Document
impl UnwindSafe for Document
Blanket Implementations
Mutably borrows from an owned value. Read more