Struct sn_api::SectionTree

pub struct SectionTree { /* private fields */ }

Container for storing information about other sections in the network.

Implementations

impl SectionTree

pub fn new( genesis_sap: SectionSigned<SectionAuthorityProvider> ) -> Result<SectionTree, Error>

Create a SectionTree with just the genesis section

pub fn from_bytes(bytes: &[u8]) -> Result<SectionTree, Error>

Create a new SectionTree deserialised from bytes

pub async fn from_disk( path: &Path ) -> impl Future<Output = Result<SectionTree, Error>>

Create a new SectionTree deserialised from a file

pub fn genesis_key(&self) -> &PublicKey

Returns the genesis key of the Network

pub fn get_sections_dag(&self) -> &SectionsDAG

pub fn prefixes(&self) -> impl Iterator<Item = &Prefix>

pub fn closest( &self, name: &XorName, exclude: Option<&Prefix> ) -> Option<&SectionSigned<SectionAuthorityProvider>>

Returns the known section that is closest to the given name, regardless of whether name belongs in that section or not. If provided, it excludes any section matching the passed prefix.

pub fn all(&self) -> impl Iterator<Item = &SectionAuthorityProvider>

Returns all known sections SAP.

pub fn get(&self, prefix: &Prefix) -> Option<SectionAuthorityProvider>

Get SectionAuthorityProvider of a known section with the given prefix.

pub fn get_signed( &self, prefix: &Prefix ) -> Option<&SectionSigned<SectionAuthorityProvider>>

Get signed SectionAuthorityProvider of a known section with the given prefix.

pub fn get_signed_by_key( &self, section_key: &PublicKey ) -> Option<&SectionSigned<SectionAuthorityProvider>>

Get signed SectionAuthorityProvider of a known section with the given section key.

pub fn get_signed_by_name( &self, name: &XorName ) -> Result<SectionSigned<SectionAuthorityProvider>, Error>

Returns the section authority provider for the prefix that matches name. In case there is no prefix matches the name, we shall return the one with longest common bits. i.e. for the name of 00xxx, if we have 01 and 1, then we shall return with 01.

pub fn get_signed_by_prefix( &self, prefix: &Prefix ) -> Result<SectionSigned<SectionAuthorityProvider>, Error>

Get the section that matches prefix. In case of multiple matches, returns the one with the longest prefix.

pub fn section_keys(&self) -> Vec<PublicKey, Global>

Returns the known section public keys.

pub fn len(&self) -> usize

Number of SAPs we know about.

pub fn is_empty(&self) -> bool

Is the section tree empty?

pub fn known_sections_count(&self) -> usize

Get total number of known sections

pub fn generate_section_tree_update( &self, prefix: &Prefix ) -> Result<SectionTreeUpdate, Error>

pub fn update_the_section_tree( &mut self, section_tree_update: SectionTreeUpdate ) -> Result<bool, Error>

Update our SectionTree if the provided update can be verified Returns true if an update was made

pub fn insert_without_chain( &mut self, sap: SectionSigned<SectionAuthorityProvider> ) -> bool

For testing purpose, we may need to populate a section_tree without a proof chain.

pub async fn write_to_disk( &self, path: &Path ) -> impl Future<Output = Result<(), Error>>

Serialise and write it to disk on the provided file path

pub fn network_stats(&self, our: &SectionAuthorityProvider) -> NetworkStats

Returns network statistics.

Trait Implementations

impl Clone for SectionTree

fn clone(&self) -> SectionTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SectionTree

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SectionTree

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

Deserialize this value from the given Serde deserializer.

impl Ord for SectionTree

fn cmp(&self, other: &SectionTree) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<SectionTree> for SectionTree

fn eq(&self, other: &SectionTree) -> 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 PartialOrd<SectionTree> for SectionTree

fn partial_cmp(&self, other: &SectionTree) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SectionTree

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 Eq for SectionTree