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
impl PaidList
Sourcepub async fn new(root_dir: &Path) -> Result<Self>
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.
Sourcepub async fn insert(&self, key: &XorName) -> Result<bool>
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.
Sourcepub async fn remove(&self, key: &XorName) -> Result<bool>
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.
Sourcepub fn contains(&self, key: &XorName) -> Result<bool>
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.
Sourcepub fn count(&self) -> Result<u64>
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.
Sourcepub fn all_keys(&self) -> Result<Vec<XorName>>
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.
Sourcepub fn set_paid_out_of_range(&self, key: &XorName)
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).
Sourcepub fn clear_paid_out_of_range(&self, key: &XorName)
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.
Sourcepub fn paid_out_of_range_since(&self, key: &XorName) -> Option<Instant>
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).
Sourcepub fn set_record_out_of_range(&self, key: &XorName)
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).
Sourcepub fn clear_record_out_of_range(&self, key: &XorName)
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.
Sourcepub fn record_out_of_range_since(&self, key: &XorName) -> Option<Instant>
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).
Sourcepub async fn remove_batch(&self, keys: &[XorName]) -> Result<usize>
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§
impl !Freeze for PaidList
impl !RefUnwindSafe for PaidList
impl Send for PaidList
impl Sync for PaidList
impl Unpin for PaidList
impl UnsafeUnpin for PaidList
impl UnwindSafe for PaidList
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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