Struct struckdown::event::AnnotatedEvent

pub struct AnnotatedEvent<'data> {
    pub event: Event<'data>,
    pub location: Option<Location>,
}

Event with annotations.

An annotated event is generally the same as an Event but it contains optional annotations. Annotations are generally just the location information about where the event ocurred in the original source document.

Fields

event: Event<'data>

The actual event.

location: Option<Location>

The optional location.

Implementations

impl<'data> AnnotatedEvent<'data>

pub fn new<I: Into<Event<'data>>>(
    value: I,
    location: Option<Location>
) -> AnnotatedEvent<'data>

Shortcut to create annotated events.

Trait Implementations

impl<'data> Clone for AnnotatedEvent<'data>

pub fn clone(&self) -> AnnotatedEvent<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for AnnotatedEvent<'data>

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

Formats the value using the given formatter.

impl<'de, 'data> Deserialize<'de> for AnnotatedEvent<'data>

pub fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<'data, T: Into<Event<'data>>> From<T> for AnnotatedEvent<'data>

pub fn from(value: T) -> AnnotatedEvent<'data>

Performs the conversion.

impl<'data> Serialize for AnnotatedEvent<'data>

pub fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.