Struct Event 

pub struct Event {
    pub id: EventId,
    pub location: Location,
    pub timestamp: Timestamp,
    pub text: String,
    pub metadata: HashMap<String, String>,
    pub sources: Vec<SourceRef>,
    pub tags: Vec<String>,
}

An event in a spatial narrative.

Events are the fundamental unit of spatial narratives. Each event represents something that happened at a specific place and time.

Examples

use spatial_narrative::core::{Event, Location, Timestamp, SourceRef};

let event = Event::builder()
    .location(Location::new(40.7128, -74.0060))
    .timestamp(Timestamp::now())
    .text("Protest began at City Hall")
    .tag("protest")
    .tag("politics")
    .source(SourceRef::article("https://news.example.com/protest"))
    .metadata("participants", "5000")
    .build();

Fields

id: EventId

Unique identifier.

location: Location

Geographic location.

timestamp: Timestamp

When the event occurred.

text: String

Description of the event.

metadata: HashMap<String, String>

Key-value metadata.

sources: Vec<SourceRef>

References to source material.

tags: Vec<String>

Categorical tags.

Implementations

impl Event

pub fn new( location: Location, timestamp: Timestamp, text: impl Into<String>, ) -> Self

Creates a new event with required fields.

pub fn builder() -> EventBuilder

Creates a builder for constructing an Event.

pub fn has_tag(&self, tag: &str) -> bool

Returns true if the event has the given tag.

pub fn add_tag(&mut self, tag: impl Into<String>)

Adds a tag to the event.

pub fn remove_tag(&mut self, tag: &str)

Removes a tag from the event.

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

Gets a metadata value.

pub fn set_metadata(&mut self, key: impl Into<String>, value: impl Into<String>)

Sets a metadata value.

pub fn add_source(&mut self, source: SourceRef)

Adds a source reference.

pub fn to_geo_point(&self) -> Point<f64>

Returns the location as a geo-types Point.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Event

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Event

fn eq(&self, other: &Event) -> 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 Serialize for Event

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SpatialEntity for Event

fn location(&self) -> &Location

Returns the primary location of this entity.

fn bounds(&self) -> GeoBounds

Returns the geographic bounds of this entity.

fn to_geo_point(&self) -> Point<f64>

Returns the location as a geo-types Point.

fn is_within_bounds(&self, bounds: &GeoBounds) -> bool

Checks if this entity is within the given bounds.

impl TemporalEntity for Event

fn timestamp(&self) -> &Timestamp

Returns the primary timestamp of this entity.

fn time_range(&self) -> TimeRange

Returns the time range of this entity.

fn is_within_time_range(&self, range: &TimeRange) -> bool

Checks if this entity falls within the given time range.

impl StructuralPartialEq for Event