Skip to main content

History

raphtory::db::api::view::history

Struct History

pub struct History<'a, T>(pub T, _);

Tuple Fields§

§0: T

Implementations§

impl<'a, T: InternalHistoryOps + 'a> History<'a, T>

pub fn new(item: T) -> Self

Create a new History wrapper around an object implementing InternalHistoryOps.

pub fn reverse(self) -> History<'a, ReversedHistoryOps<T>>

Reverse the iteration order of history items returned by iter and iter_rev.

pub fn t(self) -> HistoryTimestamp<T>

Convert this History object to return timestamps (milliseconds since the Unix epoch) instead of EventTime.

pub fn dt(self) -> HistoryDateTime<T>

Convert this History object to return datetimes instead of EventTime.

pub fn event_id(self) -> HistoryEventId<T>

Convert this History object to return the event ids from EventTime entries.

pub fn intervals(self) -> Intervals<T>

Access the intervals (differences in milliseconds) between consecutive timestamps in this History object.

pub fn merge<R: InternalHistoryOps>( self, right: History<'_, R>, ) -> History<'_, MergedHistory<T, R>>

Merge this History with another History.

pub fn iter(&self) -> BoxedLIter<'_, EventTime>

Iterate over EventTime entries in chronological order.

pub fn iter_rev(&self) -> BoxedLIter<'_, EventTime>

Iterate over EventTime entries in reverse chronological order.

pub fn collect(&self) -> Vec<EventTime>

Collect all EventTime entries in chronological order.

pub fn collect_rev(&self) -> Vec<EventTime>

Collect all EventTime entries in reverse chronological order.

pub fn is_empty(&self) -> bool

Check whether this history has no entries.

pub fn len(&self) -> usize

Get the number of entries in this history.

pub fn earliest_time(&self) -> Option<EventTime>

Get the earliest EventTime entry in this History.

pub fn latest_time(&self) -> Option<EventTime>

Get the latest EventTime entry in this History.

pub fn first(&self) -> Option<EventTime>

Get the first item produced by forward iteration in this History.

pub fn last(&self) -> Option<EventTime>

Get the first item produced by reverse iteration in this History.

pub fn as_ref(&self) -> History<'_, &T>

Borrow this history as a History of a reference to the underlying item.

pub fn print(&self, prelude: &str)

Print the collected entries with a prelude message.

impl<'a, 'b, T: InternalHistoryOps + Clone + 'b> History<'a, &'a T>

pub fn cloned(&self) -> History<'b, T>

Clone the underlying item and return an owned History.

impl History<'_, EmptyHistory>

pub fn create_empty() -> Self

Create an empty history.

impl<T: IntoArcDynHistoryOps> History<'_, T>

pub fn into_arc_dyn(self) -> History<'static, Arc<dyn InternalHistoryOps>>

Convert this history into an Arc to enable dynamic dispatch and sharing (through Send + Sync). Particularly useful for Python.

Trait Implementations§

impl<'a, T: Clone> Clone for History<'a, T>

fn clone(&self) -> History<'a, T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'a, T: Debug> Debug for History<'a, T>

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

Formats the value using the given formatter. Read more

impl<'graph, G: GraphView + 'graph> From<History<'graph, NodeView<'graph, G>>> for HistoryStruct

fn from(history: History<'graph, NodeView<'graph, G>>) -> Self

Converts to this type from the input type.

impl<'a, T: InternalHistoryOps + 'a> IntoIterator for History<'a, T>

type Item = EventTime

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = EventTime> + Send + Sync + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

impl<'b, T: InternalHistoryOps + 'b, L, I: Copy> PartialEq<L> for History<'b, T>
where for<'a> &'a L: IntoIterator<Item = &'a I>, EventTime: PartialEq<I>,

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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<'a, T: InternalHistoryOps + 'a> PartialEq for History<'a, T>

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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<'a, T: Copy> Copy for History<'a, T>

impl<'a, T: InternalHistoryOps + 'a> Eq for History<'a, T>

Auto Trait Implementations§

impl<'a, T> Freeze for History<'a, T>
where T: Freeze,

impl<'a, T> RefUnwindSafe for History<'a, T>
where T: RefUnwindSafe,

impl<'a, T> Send for History<'a, T>
where T: Send + Sync,

impl<'a, T> Sync for History<'a, T>
where T: Sync,

impl<'a, T> Unpin for History<'a, T>
where T: Unpin,

impl<'a, T> UnsafeUnpin for History<'a, T>
where T: UnsafeUnpin,

impl<'a, T> UnwindSafe for History<'a, T>
where T: UnwindSafe + RefUnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> DynEq for T
where T: Eq + Any,

fn dyn_eq(&self, other: &(dyn Any + 'static)) -> bool

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

impl<T> StateType for T
where T: PartialEq + Clone + Debug + Send + Sync + 'static,