pub enum Op {
StoreRecord(StoreRecord),
StoreEntry(StoreEntry),
RegisterUpdate(RegisterUpdate),
RegisterDelete(RegisterDelete),
RegisterAgentActivity(RegisterAgentActivity),
RegisterCreateLink(RegisterCreateLink),
RegisterDeleteLink(RegisterDeleteLink),
}
Expand description
These are the operations that can be applied to Holochain data.
Every Action
produces a set of operations.
These operations are each sent to an authority for validation.
§Examples
Validate a new entry: https://github.com/holochain/holochain/blob/develop/crates/test_utils/wasm/wasm_workspace/validate/src/integrity.rs
§Producing Operations
The following is a list of the operations that can be produced by each Action
:
- Every
Action
produces aOp::RegisterAgentActivity
and aOp::StoreRecord
. Action::Create
also produces aOp::StoreEntry
.Action::Update
also produces aOp::StoreEntry
and aOp::RegisterUpdate
.Action::Delete
also produces aOp::RegisterDelete
.Action::CreateLink
also produces aOp::RegisterCreateLink
.Action::DeleteLink
also produces aOp::RegisterDeleteLink
.
§Authorities
There are three types of authorities in Holochain:
§The Action Authority
This set of authorities receives the Op::StoreRecord
.
This is where you can implement your own logic for checking
that it is valid to store any of the Action
variants
according to your own applications rules.
§The Entry Authority
This set of authorities receives the Op::StoreEntry
.
This is where you can implement your own logic for checking
that it is valid to store an Entry
.
You can think of this as the “Create” from the CRUD acronym.
§Metadata
The entry authority is also responsible for storing the metadata for each entry.
They receive the Op::RegisterUpdate
and Op::RegisterDelete
.
This is where you can implement your own logic for checking that it is valid to
update or delete any of the Entry
types defined in your application.
You can think of this as the “Update” and “Delete” from the CRUD acronym.
They receive the Op::RegisterCreateLink
and Op::RegisterDeleteLink
.
This is where you can implement your own logic for checking that it is valid to
place a link on a base Entry
.
§The Chain Authority
This set of authorities receives the Op::RegisterAgentActivity
.
This is where you can implement your own logic for checking that it is valid to
add a new Action
to an agent source chain.
You are not validating the individual record but the entire agents source chain.
§Author
When authoring a new Action
to your source chain, the
validation will be run from the perspective of every authority.
§A note on metadata for the Action authority.
Technically speaking the Action authority also receives and validates the
Op::RegisterUpdate
and Op::RegisterDelete
but they run the same callback
as the Entry authority because it would be inconsistent to have two separate
validation outcomes for these ops.
§Running Validation
When the fn validate(op: Op) -> ExternResult<ValidateCallbackResult>
is called
it will be passed the operation variant for the authority that is
actually running the validation.
For example the entry authority will be passed the Op::StoreEntry
operation.
The operations that can be applied to Holochain data.
Operations beginning with Store
are concerned with creating and
storing data.
Operations beginning with Register
are concerned with registering
metadata about the data.
Variants§
StoreRecord(StoreRecord)
Stores a new Record
in the DHT.
This is the act of creating a new Action
and publishing it to the DHT.
Note that not all Action
s contain an Entry
.
StoreEntry(StoreEntry)
Stores a new Entry
in the DHT.
This is the act of creating a either a Action::Create
or
a Action::Update
and publishing it to the DHT.
These actions create a new instance of an Entry
.
RegisterUpdate(RegisterUpdate)
Registers an update from an instance of an Entry
in the DHT.
This is the act of creating a Action::Update
and
publishing it to the DHT.
Note that the Action::Update
stores an new instance
of an Entry
and registers it as an update to the original Entry
.
This operation is only concerned with registering the update.
RegisterDelete(RegisterDelete)
Registers a deletion of an instance of an Entry
in the DHT.
This is the act of creating a Action::Delete
and
publishing it to the DHT.
RegisterAgentActivity(RegisterAgentActivity)
Registers a new Action
on an agent source chain.
This is the act of creating any Action
and
publishing it to the DHT.
RegisterCreateLink(RegisterCreateLink)
Registers a link between two Entry
s.
This is the act of creating a Action::CreateLink
and
publishing it to the DHT.
The authority is the entry authority for the base Entry
.
RegisterDeleteLink(RegisterDeleteLink)
Deletes a link between two Entry
s.
This is the act of creating a Action::DeleteLink
and
publishing it to the DHT.
The delete always references a specific Action::CreateLink
.
Implementations§
§impl Op
impl Op
Get the AgentPubKey
for the author of this op.
pub fn action_seq(&self) -> u32
pub fn action_seq(&self) -> u32
Get the action sequence this op.
pub fn prev_action(&self) -> Option<&HoloHash<Action>>
pub fn prev_action(&self) -> Option<&HoloHash<Action>>
Get the ActionHash
for the the previous action from this op if there is one.
pub fn action_type(&self) -> ActionType
pub fn action_type(&self) -> ActionType
Get the ActionType
of this op.
pub fn entry_data(&self) -> Option<(&HoloHash<Entry>, &EntryType)>
pub fn entry_data(&self) -> Option<(&HoloHash<Entry>, &EntryType)>
Get the entry-related data for this op, if applicable
Trait Implementations§
§impl<'de> Deserialize<'de> for Op
impl<'de> Deserialize<'de> for Op
§fn deserialize<__D>(
__deserializer: __D
) -> Result<Op, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<Op, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
§impl Serialize for Op
impl Serialize for Op
§fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
§impl TryFrom<&Op> for SerializedBytes
impl TryFrom<&Op> for SerializedBytes
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(t: &Op) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: &Op) -> Result<SerializedBytes, SerializedBytesError>
§impl TryFrom<Op> for SerializedBytes
impl TryFrom<Op> for SerializedBytes
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(t: Op) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: Op) -> Result<SerializedBytes, SerializedBytesError>
§impl TryFrom<SerializedBytes> for Op
impl TryFrom<SerializedBytes> for Op
§type Error = SerializedBytesError
type Error = SerializedBytesError
§fn try_from(sb: SerializedBytes) -> Result<Op, SerializedBytesError>
fn try_from(sb: SerializedBytes) -> Result<Op, SerializedBytesError>
impl StructuralPartialEq for Op
Auto Trait Implementations§
impl RefUnwindSafe for Op
impl Send for Op
impl Sync for Op
impl Unpin for Op
impl UnwindSafe for Op
Blanket Implementations§
§impl<T> AnySync for T
impl<T> AnySync for T
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata ) -> <T as Pointee>::Metadata
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
§fn deserialize(
&self,
deserializer: &mut D
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D ) -> Result<With<T, W>, <D as Fallible>::Error>
source§impl<T> FutureExt for T
impl<T> FutureExt for T
source§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
source§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.