Struct ProviderStore 

pub struct ProviderStore { /* private fields */ }

A node’s local provider records + the set of content keys it announces itself.

Implementations

impl ProviderStore

pub fn new() -> Self

A new empty store with the default ProviderStoreLimits.

pub fn with_limits(limits: ProviderStoreLimits) -> Self

A new empty store enforcing limits on every put.

pub fn put(&mut self, record: ProviderRecord) -> PutOutcome

Store (or refresh) a provider record, subject to ProviderStoreLimits.

Keyed by (content_key, provider_peer_id): a second record from the same provider for the same key REPLACES the first (refreshes expiry + addresses) rather than duplicating — this always succeeds regardless of capacity, since it does not grow the store.

A genuinely new (content_key, provider) pair is admission-controlled:

• if the key already holds ProviderStoreLimits::max_providers_per_key other providers, the soonest-to-expire one is evicted to make room (soonest-to-expire is the least valuable record to keep);
• if the store is at ProviderStoreLimits::max_total_records globally, the new record is rejected — PutOutcome::RejectedOverCapacity — rather than evicting another key’s records (which would let one attacker’s flood evict another key’s legitimate holders).

pub fn remove(&mut self, content_key: &str, provider_peer_id: &str) -> bool

Remove exactly the record for (content_key, provider_peer_id), if present. Returns whether a record was removed.

This is the store half of an authenticated retract (SPEC §6.6): a caller that has verified a signed retract from provider_peer_id removes only that provider’s record for that key. It MUST NOT touch any OTHER provider of the same key — a retract signed by one holder can never evict another holder’s record (censorship-resistance). A content key left with no remaining providers is dropped so the store does not accumulate empty entries.

pub fn get(&self, content_key: &str, now: u64) -> Vec<ProviderRecord>

The live (non-expired at now) provider records for content_key. Expired records are skipped (and cleaned up by gc); returns an empty vec if none are known/live.

pub fn gc(&mut self, now: u64) -> usize

Drop every expired record (and any content key left with no live providers) as of now. Returns the number of records removed. Call periodically from the maintenance loop.

pub fn mark_announced(&mut self, content_key: String)

Record that this node holds + announces content_key (so the maintenance loop republishes it). Idempotent.

pub fn unmark_announced(&mut self, content_key: &str) -> bool

Stop announcing content_key (this node no longer holds the content). Returns whether it was being announced.

pub fn local_announcements(&self) -> Vec<String>

The content keys this node announces (holds) — the republish work list.

pub fn len(&self) -> usize

Total live+stale records across all keys (diagnostics / tests).

pub fn is_empty(&self) -> bool

Whether the store holds no records.

Trait Implementations

impl Debug for ProviderStore

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

Formats the value using the given formatter.

impl Default for ProviderStore

fn default() -> Self

Returns the “default value” for a type.