Enum sp_runtime::generic::DigestItemRef

pub enum DigestItemRef<'a> {
    PreRuntime(&'a ConsensusEngineId, &'a [u8]),
    Consensus(&'a ConsensusEngineId, &'a [u8]),
    Seal(&'a ConsensusEngineId, &'a [u8]),
    Other(&'a [u8]),
    RuntimeEnvironmentUpdated,
}

A ‘referencing view’ for digest item. Does not own its contents. Used by final runtime implementations for encoding/decoding its log items.

Variants

PreRuntime(&'a ConsensusEngineId, &'a [u8])

A pre-runtime digest.

These are messages from the consensus engine to the runtime, although the consensus engine can (and should) read them itself to avoid code and state duplication. It is erroneous for a runtime to produce these, but this is not (yet) checked.

Consensus(&'a ConsensusEngineId, &'a [u8])

A message from the runtime to the consensus engine. This should never be generated by the native code of any consensus engine, but this is not checked (yet).

Seal(&'a ConsensusEngineId, &'a [u8])

Put a Seal on it. This is only used by native code, and is never seen by runtimes.

Other(&'a [u8])

Any ‘non-system’ digest item, opaque to the native code.

RuntimeEnvironmentUpdated

Runtime code or heap pages updated.

Implementations

impl<'a> DigestItemRef<'a>

pub fn as_pre_runtime(&self) -> Option<(ConsensusEngineId, &'a [u8])>

Cast this digest item into PreRuntime

Examples found in repository

src/generic/digest.rs (line 235)

	pub fn as_pre_runtime(&self) -> Option<(ConsensusEngineId, &[u8])> {
		self.dref().as_pre_runtime()
	}

pub fn as_consensus(&self) -> Option<(ConsensusEngineId, &'a [u8])>

Cast this digest item into Consensus

Examples found in repository

src/generic/digest.rs (line 240)

	pub fn as_consensus(&self) -> Option<(ConsensusEngineId, &[u8])> {
		self.dref().as_consensus()
	}

pub fn as_seal(&self) -> Option<(ConsensusEngineId, &'a [u8])>

Cast this digest item into Seal

Examples found in repository

src/generic/digest.rs (line 245)

	pub fn as_seal(&self) -> Option<(ConsensusEngineId, &[u8])> {
		self.dref().as_seal()
	}

pub fn as_other(&self) -> Option<&'a [u8]>

Cast this digest item into PreRuntime

Examples found in repository

src/generic/digest.rs (line 250)

	pub fn as_other(&self) -> Option<&[u8]> {
		self.dref().as_other()
	}

pub fn try_as_raw(&self, id: OpaqueDigestItemId<'_>) -> Option<&'a [u8]>

Try to match this digest item to the given opaque item identifier; if it matches, then return the opaque data it contains.

Examples found in repository

src/generic/digest.rs (line 255)

	pub fn try_as_raw(&self, id: OpaqueDigestItemId) -> Option<&[u8]> {
		self.dref().try_as_raw(id)
	}

	/// Returns the data contained in the item if `Some` if this entry has the id given, decoded
	/// to the type provided `T`.
	pub fn try_to<T: Decode>(&self, id: OpaqueDigestItemId) -> Option<T> {
		self.dref().try_to::<T>(id)
	}

	/// Try to match this to a `Self::Seal`, check `id` matches and decode it.
	///
	/// Returns `None` if this isn't a seal item, the `id` doesn't match or when the decoding fails.
	pub fn seal_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().seal_try_to(id)
	}

	/// Try to match this to a `Self::Consensus`, check `id` matches and decode it.
	///
	/// Returns `None` if this isn't a consensus item, the `id` doesn't match or
	/// when the decoding fails.
	pub fn consensus_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().consensus_try_to(id)
	}

	/// Try to match this to a `Self::PreRuntime`, check `id` matches and decode it.
	///
	/// Returns `None` if this isn't a pre-runtime item, the `id` doesn't match or
	/// when the decoding fails.
	pub fn pre_runtime_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().pre_runtime_try_to(id)
	}
}

impl Encode for DigestItem {
	fn encode(&self) -> Vec<u8> {
		self.dref().encode()
	}
}

impl codec::EncodeLike for DigestItem {}

impl Decode for DigestItem {
	#[allow(deprecated)]
	fn decode<I: Input>(input: &mut I) -> Result<Self, Error> {
		let item_type: DigestItemType = Decode::decode(input)?;
		match item_type {
			DigestItemType::PreRuntime => {
				let vals: (ConsensusEngineId, Vec<u8>) = Decode::decode(input)?;
				Ok(Self::PreRuntime(vals.0, vals.1))
			},
			DigestItemType::Consensus => {
				let vals: (ConsensusEngineId, Vec<u8>) = Decode::decode(input)?;
				Ok(Self::Consensus(vals.0, vals.1))
			},
			DigestItemType::Seal => {
				let vals: (ConsensusEngineId, Vec<u8>) = Decode::decode(input)?;
				Ok(Self::Seal(vals.0, vals.1))
			},
			DigestItemType::Other => Ok(Self::Other(Decode::decode(input)?)),
			DigestItemType::RuntimeEnvironmentUpdated => Ok(Self::RuntimeEnvironmentUpdated),
		}
	}
}

impl<'a> DigestItemRef<'a> {
	/// Cast this digest item into `PreRuntime`
	pub fn as_pre_runtime(&self) -> Option<(ConsensusEngineId, &'a [u8])> {
		match *self {
			Self::PreRuntime(consensus_engine_id, data) => Some((*consensus_engine_id, data)),
			_ => None,
		}
	}

	/// Cast this digest item into `Consensus`
	pub fn as_consensus(&self) -> Option<(ConsensusEngineId, &'a [u8])> {
		match *self {
			Self::Consensus(consensus_engine_id, data) => Some((*consensus_engine_id, data)),
			_ => None,
		}
	}

	/// Cast this digest item into `Seal`
	pub fn as_seal(&self) -> Option<(ConsensusEngineId, &'a [u8])> {
		match *self {
			Self::Seal(consensus_engine_id, data) => Some((*consensus_engine_id, data)),
			_ => None,
		}
	}

	/// Cast this digest item into `PreRuntime`
	pub fn as_other(&self) -> Option<&'a [u8]> {
		match *self {
			Self::Other(data) => Some(data),
			_ => None,
		}
	}

	/// Try to match this digest item to the given opaque item identifier; if it matches, then
	/// return the opaque data it contains.
	pub fn try_as_raw(&self, id: OpaqueDigestItemId) -> Option<&'a [u8]> {
		match (id, self) {
			(OpaqueDigestItemId::Consensus(w), &Self::Consensus(v, s)) |
			(OpaqueDigestItemId::Seal(w), &Self::Seal(v, s)) |
			(OpaqueDigestItemId::PreRuntime(w), &Self::PreRuntime(v, s))
				if v == w =>
				Some(s),
			(OpaqueDigestItemId::Other, &Self::Other(s)) => Some(s),
			_ => None,
		}
	}

	/// Try to match this digest item to the given opaque item identifier; if it matches, then
	/// try to cast to the given data type; if that works, return it.
	pub fn try_to<T: Decode>(&self, id: OpaqueDigestItemId) -> Option<T> {
		self.try_as_raw(id).and_then(|mut x| Decode::decode(&mut x).ok())
	}

pub fn try_to<T: Decode>(&self, id: OpaqueDigestItemId<'_>) -> Option<T>

Try to match this digest item to the given opaque item identifier; if it matches, then try to cast to the given data type; if that works, return it.

Examples found in repository

src/generic/digest.rs (line 261)

	pub fn try_to<T: Decode>(&self, id: OpaqueDigestItemId) -> Option<T> {
		self.dref().try_to::<T>(id)
	}

pub fn seal_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T>

Try to match this to a Self::Seal, check id matches and decode it.

Returns None if this isn’t a seal item, the id doesn’t match or when the decoding fails.

Examples found in repository

src/generic/digest.rs (line 268)

	pub fn seal_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().seal_try_to(id)
	}

pub fn consensus_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T>

Try to match this to a Self::Consensus, check id matches and decode it.

Returns None if this isn’t a consensus item, the id doesn’t match or when the decoding fails.

Examples found in repository

src/generic/digest.rs (line 276)

	pub fn consensus_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().consensus_try_to(id)
	}

pub fn pre_runtime_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T>

Try to match this to a Self::PreRuntime, check id matches and decode it.

Returns None if this isn’t a pre-runtime item, the id doesn’t match or when the decoding fails.

Examples found in repository

src/generic/digest.rs (line 284)

	pub fn pre_runtime_try_to<T: Decode>(&self, id: &ConsensusEngineId) -> Option<T> {
		self.dref().pre_runtime_try_to(id)
	}

Trait Implementations

impl<'a> Clone for DigestItemRef<'a>

fn clone(&self) -> DigestItemRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DigestItemRef<'a>

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

Formats the value using the given formatter.

impl<'a> Encode for DigestItemRef<'a>

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<T>(&self, dest: &mut T)where
    T: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<'a> PartialEq<DigestItemRef<'a>> for DigestItemRef<'a>

fn eq(&self, other: &DigestItemRef<'a>) -> 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<'a> EncodeLike<DigestItemRef<'a>> for DigestItemRef<'a>

impl<'a> Eq for DigestItemRef<'a>

impl<'a> StructuralEq for DigestItemRef<'a>

impl<'a> StructuralPartialEq for DigestItemRef<'a>