Enum holochain_types::dht_op::DhtOp

pub enum DhtOp {
    StoreRecord(Signature, Action, Option<Box<Entry>>),
    StoreEntry(Signature, NewEntryAction, Box<Entry>),
    RegisterAgentActivity(Signature, Action),
    RegisterUpdatedContent(Signature, Update, Option<Box<Entry>>),
    RegisterUpdatedRecord(Signature, Update, Option<Box<Entry>>),
    RegisterDeletedBy(Signature, Delete),
    RegisterDeletedEntryAction(Signature, Delete),
    RegisterAddLink(Signature, CreateLink),
    RegisterRemoveLink(Signature, DeleteLink),
}

A unit of DHT gossip. Used to notify an authority of new (meta)data to hold as well as changes to the status of already held data.

Variants

StoreRecord(Signature, Action, Option<Box<Entry>>)

Used to notify the authority for an action that it has been created.

Conceptually, authorities receiving this DhtOp do three things:

• Ensure that the record passes validation.
• Store the action into their DHT shard.
• Store the entry into their CAS.
  • Note: they do not become responsible for keeping the set of references from that entry up-to-date.

StoreEntry(Signature, NewEntryAction, Box<Entry>)

Used to notify the authority for an entry that it has been created anew. (The same entry can be created more than once.)

Conceptually, authorities receiving this DhtOp do four things:

• Ensure that the record passes validation.
• Store the entry into their DHT shard.
• Store the action into their CAS.
  • Note: they do not become responsible for keeping the set of references from that action up-to-date.
• Add a “created-by” reference from the entry to the hash of the action.

TODO: document how those “created-by” references are stored in reality.

RegisterAgentActivity(Signature, Action)

Used to notify the authority for an agent’s public key that that agent has committed a new action.

Conceptually, authorities receiving this DhtOp do three things:

• Ensure that the action alone passes surface-level validation.
• Store the action into their DHT shard.
  • FIXME: @artbrock, do they?
• Add an “agent-activity” reference from the public key to the hash of the action.

TODO: document how those “agent-activity” references are stored in reality.

RegisterUpdatedContent(Signature, Update, Option<Box<Entry>>)

Op for updating an entry. This is sent to the entry authority.

RegisterUpdatedRecord(Signature, Update, Option<Box<Entry>>)

Op for updating a record. This is sent to the record authority.

RegisterDeletedBy(Signature, Delete)

Op for registering an action deletion with the Action authority

RegisterDeletedEntryAction(Signature, Delete)

Op for registering an action deletion with the Entry authority, so that the Entry can be marked Dead if all of its Actions have been deleted

RegisterAddLink(Signature, CreateLink)

Op for adding a link

RegisterRemoveLink(Signature, DeleteLink)

Op for removing a link

Implementations

impl DhtOp

pub fn author_mut(&mut self) -> &mut AgentPubKey

Mutable access to the Author

pub fn timestamp(&self) -> Timestamp

Access to the Timestamp

pub fn timestamp_mut(&mut self) -> &mut Timestamp

Mutable access to the Timestamp

pub fn signature_mut(&mut self) -> &mut Signature

Mutable access to the Signature

pub fn action_seq_mut(&mut self) -> Option<&mut u32>

Mutable access to the seq of the Action, if applicable

pub fn action_entry_data_mut(
    &mut self
) -> Option<(&mut EntryHash, &mut EntryType)>

Mutable access to the entry data of the Action, if applicable

impl DhtOp

pub fn dht_basis(&self) -> AnyDhtHash

Returns the basis hash which determines which agents will receive this DhtOp

pub fn to_light(&self) -> DhtOpLight

Convert a DhtOp to a DhtOpLight and basis

pub fn signature(&self) -> &Signature

Get the signature for this op

pub fn into_inner(self) -> (Signature, Action, Option<Entry>)

Extract inner Signature, Action and Option from an op

pub fn action(&self) -> Action

Get the action from this op This requires cloning and converting the action as some ops don’t hold the Action type

pub fn entry(&self) -> Option<&Entry>

Get the entry from this op, if one exists

pub fn get_type(&self) -> DhtOpType

Get the type as a unit enum, for Display purposes

pub fn from_type(
    op_type: DhtOpType,
    action: SignedAction,
    entry: Option<Entry>
) -> DhtOpResult<Self>

From a type, action and an entry (if there is one)

pub fn enzymatic_countersigning_enzyme(&self) -> Option<&AgentPubKey>

Enzymatic countersigning session ops need special handling so that they arrive at the enzyme and not elsewhere. If this isn’t an enzymatic countersigning session then the return will be None so can be used as a boolean for filtering with is_some().

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for DhtOp

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for DhtOp

fn clone(&self) -> DhtOp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DhtOp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DhtOp

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DhtOp

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

Formats the value using the given formatter.

impl HashableContent for DhtOp

type HashType = DhtOp

The HashType which this content will be hashed to

fn hash_type(&self) -> Self::HashType

The HashType which this content will be hashed to

fn hashable_content(&self) -> HashableContentBytes

Return a subset of the content, either as SerializedBytes “content”, which will be used to compute the hash, or as an already precomputed hash which will be used directly

impl OpRegion<RegionData> for DhtOp

fn loc(&self) -> Loc

The op’s Location

fn timestamp(&self) -> Timestamp

The op’s Timestamp

fn region_data(&self) -> RegionData

The RegionData that would be produced if this op were the only op in the region. The sum of these produces the RegionData for the whole region.

fn bound(_timestamp: Timestamp, _loc: Loc) -> Self

Create an Op with arbitrary data but that has the given timestamp and location. Used for bounded range queries based on the PartialOrd impl of the op.

fn coords(&self, topo: &Topology) -> SpacetimeQuantumCoords

The quantized space and time coordinates, based on the location and timestamp.

impl Ord for DhtOp

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<DhtOp> for DhtOp

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DhtOp> for DhtOp

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for DhtOp

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

Serialize this value into the given Serde serializer.

impl TryFrom<&DhtOp> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: &DhtOp) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<DhtOp> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(t: DhtOp) -> Result<SerializedBytes, SerializedBytesError>

Performs the conversion.

impl TryFrom<SerializedBytes> for DhtOp

type Error = SerializedBytesError

The type returned in the event of a conversion error.

fn try_from(sb: SerializedBytes) -> Result<DhtOp, SerializedBytesError>

Performs the conversion.

impl Eq for DhtOp

impl StructuralEq for DhtOp

impl StructuralPartialEq for DhtOp