Enum VersionedEvent

pub enum VersionedEvent {
    V1(EventV1),
}

New version variants should be added if fields need to be added, changed, or removed.

Variants

V1(EventV1)

Implementations

impl VersionedEvent

pub fn new( id: u64, event_type: EventType, object_type: ObjectType, details: EventDetails, user: Option<String>, occurred_at: EpochMillis, ) -> Self

Create a new event. This function must always require and produce the most recent variant of VersionedEvent. id must be a globally increasing, ordered number such that sorting by it on all events yields the order of events by users. It is insufficient to use occurred_at (even at nanosecond precision) due to clock unpredictability.

pub fn deserialize(data: &[u8]) -> Result<Self, Error>

pub fn serialize(&self) -> Vec<u8>

pub fn sortable_id(&self) -> u64

Returns a globally sortable event order. All event versions must have this field.

Trait Implementations

impl Arbitrary for VersionedEvent

type Parameters = <EventV1 as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Map<<EventV1 as Arbitrary>::Strategy, fn(_: EventV1) -> VersionedEvent>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_top: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for VersionedEvent

fn clone(&self) -> VersionedEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VersionedEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VersionedEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for VersionedEvent

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VersionedEvent

fn cmp(&self, other: &VersionedEvent) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VersionedEvent

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

fn partial_cmp(&self, other: &VersionedEvent) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VersionedEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VersionedEvent

impl StructuralPartialEq for VersionedEvent