Struct Identity

pub struct Identity { /* private fields */ }

A user identity. This is a unique representation of an user.

Implementations

impl Identity

pub fn read_legacy( replica: &Replica, id: EntityId<Self>, ) -> Result<Vec<VersionEntry>, Error>

Fetch an Identity from it’s legacy encoding from a git repository and decode it.

The legacy encoding is used by git-bug. This is only useful, if you need fine grained access to the concrete data. If you simply want to access an Identity, use Identity::read instead.

Errors

If the associated git operations fail.

Trait Implementations

impl Debug for Identity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Identity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Entity for Identity

const FORMAT_VERSION: usize = 4usize

The expected format version number, that can be used for data migration/upgrade.

const NAMESPACE: &str = "identities"

The namespace in git references (bugs, prs, …).

const TYPENAME: &str = "Identity"

The name of the entity (issue, pull-request, …), for human consumption.

type HistoryStep = IdentityHistoryStep

A step in the history of a Snapshot's Timeline.

type OperationData = IdentityOperationData

The type of Operation this Entity uses.

type Timeline = IdentityTimeline

The complete timeline of an Snapshot of this Entity.

fn operations(&self) -> &Operations<Self>

where Self: Sized,

Return the Operations that compose this Entity.

unsafe fn from_parts( operations: Operations<Self>, create_time: Time, edit_time: Time, current_head: ObjectId, ) -> Self

where Self: Sized,

Construct this instance from the data stored on disk.

fn create_time(&self) -> &Time

where Self: Sized,

Return the lamport::Time that was set, when this Entity was first created.

fn edit_time(&self) -> &Time

where Self: Sized,

Return the lamport::Time that was set, when this Entity was last edited.

fn current_head(&self) -> &oid

where Self: Sized,

Return the commit object id of the last commit that added operations to this Entity.

fn id(&self) -> EntityId<Self>

where Self: Sized,

Return this Entity’s EntityId.

fn snapshot(&self) -> Snapshot<Self>

Generate a snapshot of this Entity. This is a frozen collection of this Entity's Operations.

impl EntityRead for Identity

type CustomReadError = Error

An error that can be used to add to the default Error in read.

fn read(replica: &Replica, id: EntityId<Self>) -> Result<Self, Error<Self>>

where Self: Sized,

Fetch this Entity from a git repository and decode it.

fn last_git_commit( replica: &Replica, id: EntityId<Self>, ) -> Result<ObjectId, Error>

Get the commit associated with the last entry of this Entity's Operations.

fn breadth_first_search( repo: &Repository, root_id: ObjectId, ) -> Result<Vec<Commit<'_>>, Error>

A breadth-first search to get a topological order of the Operations DAG where we discover the parents commit and go back in time up to the chronological root

impl Serialize for Identity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Timeline<Identity> for IdentityTimeline

fn new() -> Self

Construct a new, empty Timeline.

fn from_root_operation(operation: &Operation<Identity>) -> Self

Construct an Timeline from a root operation.

fn add(&mut self, op: &Operation<Identity>)

Add an operation to this timeline.

fn history(&self) -> &[<Identity as Entity>::HistoryStep]

Return the complete history.