Struct phron_finality::sync::forest::vertex::Vertex

pub struct Vertex<I: PeerId, J: Justification> {
    inner: InnerVertex<J>,
    know_most: LruCache<I, ()>,
}

The complete vertex, including metadata about peers that know most about the data it refers to.

Fields

inner: InnerVertex<J>

know_most: LruCache<I, ()>

Implementations

impl<I: PeerId, J: Justification> Vertex<I, J>

pub fn new() -> Self

Create a new empty vertex.

pub fn importable(&self) -> bool

Whether we want the referenced block in our database.

pub fn requestable(&self) -> bool

Whether the referenced block should be requested. This ignores blocks requested due to justifications, as these will be requested separately.

pub fn imported(&self) -> bool

Whether the vertex is imported.

pub fn justified_block(&self) -> bool

Whether the vertex represents imported justified block.

pub fn ready(self) -> Result<J, Self>

Deconstructs the vertex into a justification if it is ready to be imported, i.e. the related block has already been imported, otherwise returns it.

pub fn parent(&self) -> Option<&BlockId>

The parent of the vertex, if known.

pub fn know_most(&self) -> HashSet<I>

The list of peers which know most about the data this vertex refers to.

pub fn set_explicitly_required(&mut self) -> bool

Set the vertex to be explicitly required, returns whether anything changed, i.e. the vertex was not explicitly required or imported before.

pub fn set_required(&mut self) -> bool

Set the vertex to be required, returns whether anything changed, i.e. the vertex was not required or imported before.

pub fn add_block_holder(&mut self, holder: Option<I>)

Adds a peer that knows most about the block this vertex refers to. Does nothing if we already have a justification.

pub fn insert_header(&mut self, parent: BlockId, holder: Option<I>) -> bool

Adds the information the header provides to the vertex. Returns whether this is a new header.

pub fn insert_body(&mut self, parent: BlockId) -> bool

Adds the information the header provides to the vertex and marks it as imported. Returns whether it was not imported before.

pub fn insert_justification( &mut self, parent: BlockId, justification: J, holder: Option<I> )

Adds a justification to the vertex.

Trait Implementations

impl<I: Debug + PeerId, J: Debug + Justification> Debug for Vertex<I, J>

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

Formats the value using the given formatter.