Enum hdk::prelude::RecordEntry

pub enum RecordEntry<E = Entry>
where
    E: Borrow<Entry>,
{
    Present(E),
    Hidden,
    NA,
    NotStored,
}

Represents the different ways the entry_address reference within an action can be interpreted

Variants

Present(E)

The Action has an entry_address reference, and the Entry is accessible.

Hidden

The Action has an entry_address reference, but we are in a public context and the entry is private.

NA

The Action does not contain an entry_address reference, so there will never be an associated Entry.

NotStored

The Action has an entry but was stored without it. This can happen when you receive gossip of just an action when the action type is a crate::EntryCreationAction, in particular for certain DhtOps

Implementations

impl<E> RecordEntry<E>

where E: Borrow<Entry>,

pub fn new( vis: Option<&EntryVisibility>, maybe_entry: Option<E> ) -> RecordEntry<E>

Constructor based on Action data

pub fn as_option(&self) -> Option<&E>

Provides entry data by reference if it exists

Collapses the enum down to the two possibilities of extant or nonextant Entry data

pub fn into_option(self) -> Option<E>

Provides entry data as owned value if it exists.

Collapses the enum down to the two possibilities of extant or nonextant Entry data

pub fn to_app_option<A>(&self) -> Result<Option<A>, SerializedBytesError>

where A: TryFrom<SerializedBytes, Error = SerializedBytesError>,

Provides deserialized app entry if it exists

same as as_option but handles deserialization anything other than RecordEntry::Present returns None a present entry that fails to deserialize cleanly is an error a present entry that deserializes cleanly is returned as the provided type A

pub fn as_ref<'a>(&'a self) -> RecordEntry<&'a E>

where &'a E: Borrow<Entry>,

Use a reference to the Entry, if present

pub fn to_grant_option(&self) -> Option<ZomeCallCapGrant>

Provides CapGrantEntry if it exists

same as as_option but handles cap grants anything other tha RecordEntry::Present for a Entry::CapGrant returns None

pub fn or_hidden(entry: Option<E>) -> RecordEntry<E>

If no entry is available, return Hidden, else return Present

pub fn or_not_applicable(entry: Option<E>) -> RecordEntry<E>

If no entry is available, return NotApplicable, else return Present

pub fn or_not_stored(entry: Option<E>) -> RecordEntry<E>

If no entry is available, return NotStored, else return Present

Trait Implementations

impl<E> Clone for RecordEntry<E>

where E: Clone + Borrow<Entry>,

fn clone(&self) -> RecordEntry<E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E> Debug for RecordEntry<E>

where E: Debug + Borrow<Entry>,

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

Formats the value using the given formatter.

impl<'de, E> Deserialize<'de> for RecordEntry<E>

where E: Borrow<Entry> + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<RecordEntry<E>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> From<E> for RecordEntry<E>

where E: Borrow<Entry>,

fn from(entry: E) -> RecordEntry<E>

Converts to this type from the input type.

impl<E> Hash for RecordEntry<E>

where E: Hash + Borrow<Entry>,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E> PartialEq for RecordEntry<E>

where E: PartialEq + Borrow<Entry>,

fn eq(&self, other: &RecordEntry<E>) -> 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<E> Serialize for RecordEntry<E>

where E: Borrow<Entry> + Serialize,

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.

impl TryFrom<&RecordEntry> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<RecordEntry> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<SerializedBytes> for RecordEntry

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<E> Eq for RecordEntry<E>

where E: Eq + Borrow<Entry>,

impl<E> StructuralPartialEq for RecordEntry<E>

where E: Borrow<Entry>,