Struct gedcomx::Note

#[non_exhaustive]
pub struct Note {
    pub lang: Option<Lang>,
    pub subject: Option<String>,
    pub text: String,
    pub attribution: Option<Attribution>,
}

A note that was contributed from genealogical research.

Notes are not intended to contain genealogical conclusions. Notes are only associated with a single genealogical resource.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

lang: Option<Lang>

The locale identifier for the note.

subject: Option<String>

A subject or title for the note.

text: String

The text of the note.

attribution: Option<Attribution>

The attribution of this note. If not provided, the attribution of the containing resource of the note is assumed.

Implementations

impl Note

pub fn new( lang: Option<Lang>, subject: Option<String>, text: String, attribution: Option<Attribution> ) -> Self

pub fn builder<I: Into<String>>(text: I) -> NoteBuilder

Trait Implementations

impl Arbitrary for Note

fn arbitrary(g: &mut Gen) -> Self

Return an arbitrary value.

fn shrink(&self) -> Box<dyn Iterator<Item = Self>, Global>

Return an iterator of values that are smaller than itself.

impl Clone for Note

fn clone(&self) -> Note

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl Default for Note

fn default() -> Note

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Note

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Note> for Note

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Note

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

Serialize this value into the given Serde serializer.

impl YaDeserialize for Note

fn deserialize<R: Read>(reader: &mut Deserializer<R>) -> Result<Self, String>

impl YaSerialize for Note

fn serialize<W: Write>(&self, writer: &mut Serializer<W>) -> Result<(), String>

fn serialize_attributes( &self, source_attributes: Vec<OwnedAttribute>, source_namespace: Namespace ) -> Result<(Vec<OwnedAttribute>, Namespace), String>

impl StructuralPartialEq for Note