Skip to main content

GhostNodeCache

Struct GhostNodeCache 

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

Cache of ghost nodes from other shards.

Ghost nodes are references to nodes that live on remote shards. This cache maintains a bounded set of ghost nodes using LRU eviction to keep frequently accessed nodes available while limiting memory usage.

§Example

use phago_distributed::shard::GhostNodeCache;

let mut cache = GhostNodeCache::new(100);
cache.insert(ghost_node);

if let Some(ghost) = cache.get(&node_id) {
    println!("Found ghost node: {}", ghost.label);
}

Implementations§

Source§

impl GhostNodeCache

Source

pub fn new(max_size: usize) -> Self

Create a new ghost node cache with the specified maximum size.

§Arguments
  • max_size - Maximum number of ghost nodes to cache
Source

pub fn get(&mut self, id: &NodeId) -> Option<&GhostNode>

Get a ghost node from cache.

Updates the access order for LRU tracking.

§Arguments
  • id - The node ID to look up
§Returns

A reference to the ghost node if found.

Source

pub fn peek(&self, id: &NodeId) -> Option<&GhostNode>

Get a ghost node without updating LRU order (for read-only access).

Source

pub fn insert(&mut self, ghost: GhostNode)

Insert a ghost node into the cache.

If the cache is at capacity, the least recently used node will be evicted to make room.

§Arguments
  • ghost - The ghost node to insert
Source

pub fn update_full_data(&mut self, id: &NodeId, data: NodeData)

Update a ghost node with full data fetched from the remote shard.

§Arguments
  • id - The node ID to update
  • data - The full node data
Source

pub fn contains(&self, id: &NodeId) -> bool

Check if a node is cached.

§Arguments
  • id - The node ID to check
Source

pub fn nodes_from_shard(&self, shard_id: ShardId) -> Vec<&GhostNode>

Get all ghost nodes from a specific shard.

§Arguments
  • shard_id - The shard to filter by
§Returns

A vector of references to ghost nodes from the specified shard.

Source

pub fn all_nodes(&self) -> Vec<&GhostNode>

Get all ghost nodes in the cache.

Source

pub fn remove(&mut self, id: &NodeId) -> Option<GhostNode>

Remove a ghost node from the cache.

§Arguments
  • id - The node ID to remove
§Returns

The removed ghost node if it was present.

Source

pub fn clear(&mut self)

Clear the cache.

Source

pub fn len(&self) -> usize

Number of cached nodes.

Source

pub fn is_empty(&self) -> bool

Check if cache is empty.

Source

pub fn capacity(&self) -> usize

Get the maximum cache size.

Source

pub fn invalidate_shard(&mut self, shard_id: ShardId) -> usize

Invalidate all ghost nodes from a specific shard.

This is useful when a shard becomes unavailable or undergoes significant changes.

§Arguments
  • shard_id - The shard whose nodes should be invalidated
§Returns

The number of nodes that were invalidated.

Source

pub fn stats(&self) -> GhostCacheStats

Get statistics about the cache.

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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, 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