Skip to content

Commit f3e11fd

Browse files
docs: complete docstring for is_cache_ready method
Co-Authored-By: Tejas Badadare <[email protected]>
1 parent d646c06 commit f3e11fd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

apps/hermes/server/src/state/cache.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ pub trait Cache {
136136
request_time: RequestTime,
137137
filter: MessageStateFilter,
138138
) -> Result<Vec<MessageState>>;
139+
/// Checks if the cache contains sufficient data to serve requests.
140+
///
141+
/// The cache is considered ready when it is at or near its maximum capacity.
142+
139143
async fn is_cache_ready(&self) -> bool;
140144
}
141145

0 commit comments

Comments
 (0)