Enum hdk::prelude::Header

pub enum Header {
    Dna(Dna),
    AgentValidationPkg(AgentValidationPkg),
    InitZomesComplete(InitZomesComplete),
    CreateLink(CreateLink),
    DeleteLink(DeleteLink),
    OpenChain(OpenChain),
    CloseChain(CloseChain),
    Create(Create),
    Update(Update),
    Delete(Delete),
}

Header contains variants for each type of header.

This struct really defines a local source chain, in the sense that it implements the pointers between hashes that a hash chain relies on, which are then used to check the integrity of data using cryptographic hash functions.

Variants

Dna(Dna)

AgentValidationPkg(AgentValidationPkg)

InitZomesComplete(InitZomesComplete)

CreateLink(CreateLink)

DeleteLink(DeleteLink)

OpenChain(OpenChain)

CloseChain(CloseChain)

Create(Create)

Update(Update)

Delete(Delete)

Implementations

impl Header

pub fn from_countersigning_data(
    entry_hash: HoloHash<Entry>,
    session_data: &CounterSigningSessionData,
    author: HoloHash<Agent>
) -> Result<Header, CounterSigningError>

Construct a Header from the HeaderBase and associated session data.

impl Header

pub fn entry_data(&self) -> Option<(&HoloHash<Entry>, &EntryType)>

Returns the address and entry type of the Entry, if applicable.

pub fn entry_hash(&self) -> Option<&HoloHash<Entry>>

pub fn entry_type(&self) -> Option<&EntryType>

pub fn header_type(&self) -> HeaderType

pub fn author(&self) -> &HoloHash<Agent>

returns the public key of the agent who signed this header.

pub fn timestamp(&self) -> Timestamp

returns the timestamp of when the header was created

pub fn header_seq(&self) -> u32

returns the sequence ordinal of this header

pub fn prev_header(&self) -> Option<&HoloHash<Header>>

returns the previous header except for the DNA header which doesn’t have a previous

pub fn is_genesis(&self) -> bool

Trait Implementations

impl Clone for Header

pub fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

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

Deserialize this value from the given Serde deserializer.

impl<'_> From<&'_ Header> for HeaderType

pub fn from(header: &Header) -> HeaderType

Performs the conversion.

impl From<HoloHashed<Header>> for Header

pub fn from(header_hashed: HoloHashed<Header>) -> Header

Performs the conversion.

impl<I> From<I> for Header where
    I: HeaderInner, 

pub fn from(i: I) -> Header

Performs the conversion.

impl From<SignedHeaderHashed> for Header

pub fn from(signed_header_hashed: SignedHeaderHashed) -> Header

Performs the conversion.

impl HashableContent for Header

type HashType = Header

The HashType which this content will be hashed to

pub fn hash_type(&self) -> <Header as HashableContent>::HashType

The HashType which this content will be hashed to

pub 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 PartialEq<Header> for Header

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

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

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

This method tests for !=.

impl Serialize for Header

pub 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<&'_ Header> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> TryFrom<&'a Header> for &'a DeleteLink

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &'a Header
) -> Result<&'a DeleteLink, <&'a DeleteLink as TryFrom<&'a Header>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Header> for &'a CreateLink

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &'a Header
) -> Result<&'a CreateLink, <&'a CreateLink as TryFrom<&'a Header>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Header> for &'a Update

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &'a Header
) -> Result<&'a Update, <&'a Update as TryFrom<&'a Header>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Header> for &'a Delete

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: &'a Header
) -> Result<&'a Delete, <&'a Delete as TryFrom<&'a Header>>::Error>

Performs the conversion.

impl TryFrom<Header> for SerializedBytes

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Header> for Update

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: Header
) -> Result<Update, <Update as TryFrom<Header>>::Error>

Performs the conversion.

impl TryFrom<Header> for DeleteLink

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: Header
) -> Result<DeleteLink, <DeleteLink as TryFrom<Header>>::Error>

Performs the conversion.

impl TryFrom<Header> for Delete

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: Header
) -> Result<Delete, <Delete as TryFrom<Header>>::Error>

Performs the conversion.

impl TryFrom<Header> for CreateLink

type Error = WrongHeaderError

The type returned in the event of a conversion error.

pub fn try_from(
    value: Header
) -> Result<CreateLink, <CreateLink as TryFrom<Header>>::Error>

Performs the conversion.

impl TryFrom<SerializedBytes> for Header

type Error = SerializedBytesError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header