pub enum Op {
StoreRecord(StoreRecord),
StoreEntry(StoreEntry),
RegisterUpdate(RegisterUpdate),
RegisterDelete(RegisterDelete),
RegisterAgentActivity(RegisterAgentActivity),
RegisterCreateLink(RegisterCreateLink),
RegisterDeleteLink(RegisterDeleteLink),
}
Expand description
These are the operational transformations that can be applied to Holochain data.
Every Action
produces a set of operations.
These operations are each sent to an authority for validation.
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 operational transforms that can are 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.
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>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl OpHelper for Op
impl OpHelper for Op
sourcefn to_type<ET, LT>(&self) -> Result<OpType<ET, LT>, WasmError>where
ET: EntryTypesHelper + UnitEnum,
LT: LinkTypesHelper,
<ET as UnitEnum>::Unit: Into<ZomeTypesKey<EntryDefIndex>>,
WasmError: From<<ET as EntryTypesHelper>::Error>,
WasmError: From<<LT as LinkTypesHelper>::Error>,
fn to_type<ET, LT>(&self) -> Result<OpType<ET, LT>, WasmError>where
ET: EntryTypesHelper + UnitEnum,
LT: LinkTypesHelper,
<ET as UnitEnum>::Unit: Into<ZomeTypesKey<EntryDefIndex>>,
WasmError: From<<ET as EntryTypesHelper>::Error>,
WasmError: From<<LT as LinkTypesHelper>::Error>,
impl PartialEq<Op> for Op
impl PartialEq<Op> for Op
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,
Serialize this value into the given Serde serializer. Read more
impl TryFrom<&Op> for SerializedBytes
impl TryFrom<&Op> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
fn try_from(t: &Op) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: &Op) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
impl TryFrom<Op> for SerializedBytes
impl TryFrom<Op> for SerializedBytes
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
fn try_from(t: Op) -> Result<SerializedBytes, SerializedBytesError>
fn try_from(t: Op) -> Result<SerializedBytes, SerializedBytesError>
Performs the conversion.
impl TryFrom<SerializedBytes> for Op
impl TryFrom<SerializedBytes> for Op
type Error = SerializedBytesError
type Error = SerializedBytesError
The type returned in the event of a conversion error.
fn try_from(sb: SerializedBytes) -> Result<Op, SerializedBytesError>
fn try_from(sb: SerializedBytes) -> Result<Op, SerializedBytesError>
Performs the conversion.
impl StructuralPartialEq for Op
Auto Trait Implementations
Blanket Implementations
impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
fn pointer_metadata(
&<T as ArchivePointee>::ArchivedMetadata
) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
impl<F, W, T, D> Deserialize<With<T, W>, D> for Fwhere
W: DeserializeWith<F, T, D>,
D: Fallible + ?Sized,
F: ?Sized,
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>
Deserializes using the given deserializer
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T>where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T>where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T>where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T>where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T>where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more