Skip to main content

PaidList

Struct PaidList 

Source
pub struct PaidList { /* private fields */ }
Expand description

Persistent paid-for-list backed by LMDB.

Tracks which keys this node believes are paid-authorized. Survives node restarts via LMDB persistence.

Implementations§

Source§

impl PaidList

Source

pub async fn new(root_dir: &Path) -> Result<Self>

Open or create a PaidList backed by LMDB at {root_dir}/paid_list.mdb/.

§Errors

Returns an error if the LMDB environment cannot be opened or the database cannot be created.

Source

pub async fn insert(&self, key: &XorName) -> Result<bool>

Insert a key into the paid-for set.

Returns true if the key was newly added, false if it already existed.

§Errors

Returns an error if the LMDB write transaction fails.

Source

pub async fn remove(&self, key: &XorName) -> Result<bool>

Remove a key from the paid-for set.

Also clears any in-memory out-of-range timestamps for this key.

Returns true if the key existed and was removed, false otherwise.

§Errors

Returns an error if the LMDB write transaction fails.

Source

pub fn contains(&self, key: &XorName) -> Result<bool>

Check whether a key is in the paid-for set.

This is a synchronous read-only operation (no write transaction needed).

§Errors

Returns an error if the LMDB read transaction fails.

Source

pub fn count(&self) -> Result<u64>

Return the number of keys in the paid-for set.

This is an O(1) read of the B-tree page header, not a full scan.

§Errors

Returns an error if the LMDB read transaction fails.

Source

pub fn all_keys(&self) -> Result<Vec<XorName>>

Return all keys in the paid-for set.

Used during hint construction to advertise which keys this node holds.

§Errors

Returns an error if the LMDB read transaction or iteration fails.

Source

pub fn set_paid_out_of_range(&self, key: &XorName)

Record the PaidOutOfRangeFirstSeen timestamp for a key.

Only sets the timestamp if one is not already recorded (first observation wins).

Source

pub fn clear_paid_out_of_range(&self, key: &XorName)

Clear the PaidOutOfRangeFirstSeen timestamp for a key.

Called when the key moves back into PaidCloseGroup range.

Source

pub fn paid_out_of_range_since(&self, key: &XorName) -> Option<Instant>

Get the PaidOutOfRangeFirstSeen timestamp for a key.

Returns None if the key is currently in range (no timestamp set).

Source

pub fn set_record_out_of_range(&self, key: &XorName)

Record the RecordOutOfRangeFirstSeen timestamp for a key.

Only sets the timestamp if one is not already recorded (first observation wins).

Source

pub fn clear_record_out_of_range(&self, key: &XorName)

Clear the RecordOutOfRangeFirstSeen timestamp for a key.

Called when the record moves back into storage-responsibility range.

Source

pub fn record_out_of_range_since(&self, key: &XorName) -> Option<Instant>

Get the RecordOutOfRangeFirstSeen timestamp for a key.

Returns None if the record is currently in range (no timestamp set).

Source

pub async fn remove_batch(&self, keys: &[XorName]) -> Result<usize>

Remove multiple keys in a single write transaction.

Also clears any in-memory out-of-range timestamps for removed keys.

Returns the number of keys that were actually present and removed.

§Errors

Returns an error if the LMDB write transaction fails.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more