Struct subrpc_core::LocalData

pub struct LocalData {
    pub file: PathBuf,
    pub registries: HashMap<String, Registry>,
    pub last_update: Option<DateTime<Local>>,
}

Local user data collected from the various regitries.

It contains the list of registries. Some may be disabled. The data for each registry can be updated in order to keep a fresh list of endpoints.

Fields

file: PathBuf

File where the local data are stored

registries: HashMap<String, Registry>

List of the registries where the RPC endpoints are pulled from

last_update: Option<DateTime<Local>>

DateTime of the last update of the data

Implementations

impl LocalData

pub fn get_default_file() -> PathBuf

pub fn initialized(&self) -> bool

Returns true if the local file exists

pub fn init(file: &Path, force: bool) -> Result<Self>

Initialize a DB based on a given file. After initializing a DB, you should ensure it contains at least one registry and call the Self::refresh function.

pub fn load(self) -> Result<Self>

Load LocalData and deserialize data from file.

pub fn refresh(self) -> Self

Loops through each registry, each network/chain, each endpoint and update the endpoints lists.

pub fn add_registry(self, registry: Registry) -> Self

Add a new registry. Registries are identitfied by their names, make sure the name is unique.

pub fn save(self) -> Result<Self>

Save the current state to file

pub fn get_endpoints(&self, chain: Option<&str>) -> HashSet<Endpoint>

Get a list of endpoints matching an optional filter. If not chain filter is passed, all endpoints are returned.

pub fn print_registries(&self)

Print the list of registries.

See also Self::print_summary.

pub fn print_summary(&self)

Print a summary of your local db. It shows more information than Self::print_registries.

Trait Implementations

impl Debug for LocalData

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

Formats the value using the given formatter.

impl Default for LocalData

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalData

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<LocalData> for LocalData

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LocalData