Struct Snapshot 

pub struct Snapshot<E: Entity> { /* private fields */ }

A compiled version of a Entity.

If you want to read/display this Entity, than this is the type you want. If you need to change or create an Entity, than use the functions on it directly.

An Snapshot<E> is, as the name implies, just a snapshot of the current state of an Entity. As such, it is not intended to keep these snapshots around for longer periods of time. Simply call snapshot(), use the snapshot, and drop it again.

Implementations

impl Snapshot<Identity>

pub fn name(&self) -> &str

Returns the Identity’s name at the time of this snapshot.

pub fn email(&self) -> Option<&str>

Returns the Identity’s email at the time of this snapshot.

pub fn login_name(&self) -> Option<&str>

Returns the Identity’s login name at the time of this snapshot.

pub fn avatar_url(&self) -> Option<&Url>

Returns the Identity’s avatar url at the time of this snapshot.

pub fn metadata(&self) -> Option<impl Iterator<Item = &(String, String)>>

Returns the Identity’s meta data at the time of this snapshot.

The iterator returns key value pairs.

impl Snapshot<Issue>

pub fn body(&self) -> &str

Returns the Body of the Issue at the time of this snapshot.

pub fn comments(&self) -> Vec<Comment>

Returns the Comments at the time of this snapshot.

pub fn labels(&self) -> HashSet<&Label>

Returns the active Label at the time of this snapshot.

pub fn status(&self) -> Status

Returns the active Status at the time of this snapshot.

pub fn title(&self) -> &str

Returns the Issue’s title at the time of this snapshot.

pub fn author(&self) -> IdentityStub

Return the author of this Issue

This is the same as the author of the Issue, which was used to create this snapshot.

pub fn participants(&self) -> impl Iterator<Item = IdentityStub> + use<'_>

Get an iterator over all the people that actively participated on this issue.

impl<E: Entity> Snapshot<E>

pub fn timeline(&self) -> &E::Timeline

Return the Timeline that contains all the changes to the Entity at the time of this snapshot.

pub fn id(&self) -> EntityId<E>

Get the EntityId of this Snapshot.

This is the same as the EntityId of the Entity, which was used to create this snapshot.

pub fn apply(&mut self, op: &Operation<E>)

Apply another operation to this Snapshot.

pub fn actors<'a>(&'a self) -> impl Iterator<Item = IdentityStub> + use<'a, E>

where <E as Entity>::HistoryStep: 'a,

Get an iterator over all the people that acted in this Entity.

This means, that they are an author of one of the HistorySteps that compose this timeline.

pub fn from_root_operation(op: &Operation<E>) -> Self

Construct this Snapshot from an Entity's root operation.

This is probably not what you want, you should use Entity::snapshot to get the snapshot of an Entity.

Trait Implementations

impl<E: Entity> Clone for Snapshot<E>

where E::Timeline: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Entity> Debug for Snapshot<E>

where E::Timeline: Debug,

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

Formats the value using the given formatter.

impl Display for Snapshot<Identity>

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

Formats the value using the given formatter.

impl Queryable for Snapshot<Issue>

type KeyValue = MatchKeyValue

The type defining the possible keys a user can input.

fn matches(&self, key: &Self::KeyValue) -> bool

Check whether the key value pair is a match for this Queryable object.