Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-27 21:43:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Auto merge of #18011 - Wilfred:op_queue_doc_comments, r=Veykril

Browse source 
internal: Add doc comments to OpQueue

I spent a while debugging some OpQueue behaviours and found the API slightly confusing, so I've added doc comments to clarify what each OpQueue method does.
This commit is contained in:
bors 2024-08-31 04:54:50 +00:00
commit 1a84cd68a8
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
crates/rust-analyzer/src/op_queue.rs
View file

@ -37,9 +37,13 @@ impl<Args, Output: Default> Default for OpQueue<Args, Output> {
} }
impl<Args, Output> OpQueue<Args, Output> { impl<Args, Output> OpQueue<Args, Output> {
/// Request an operation to start.
pub(crate) fn request_op(&mut self, reason: Cause, args: Args) { pub(crate) fn request_op(&mut self, reason: Cause, args: Args) {
self.op_requested = Some((reason, args)); self.op_requested = Some((reason, args));
} }
/// If there was an operation requested, mark this queue as
/// started and return the request arguments.
pub(crate) fn should_start_op(&mut self) -> Option<(Cause, Args)> { pub(crate) fn should_start_op(&mut self) -> Option<(Cause, Args)> {
if self.op_in_progress { if self.op_in_progress {
return None; return None;
@ -47,18 +51,25 @@ impl<Args, Output> OpQueue<Args, Output> {
self.op_in_progress = self.op_requested.is_some(); self.op_in_progress = self.op_requested.is_some();
self.op_requested.take() self.op_requested.take()
} }
/// Mark an operation as completed.
pub(crate) fn op_completed(&mut self, result: Output) { pub(crate) fn op_completed(&mut self, result: Output) {
assert!(self.op_in_progress); assert!(self.op_in_progress);
self.op_in_progress = false; self.op_in_progress = false;
self.last_op_result = result; self.last_op_result = result;
} }
/// Get the result of the last operation.
pub(crate) fn last_op_result(&self) -> &Output { pub(crate) fn last_op_result(&self) -> &Output {
&self.last_op_result &self.last_op_result
} }
// Is there an operation that has started, but hasn't yet finished?
pub(crate) fn op_in_progress(&self) -> bool { pub(crate) fn op_in_progress(&self) -> bool {
self.op_in_progress self.op_in_progress
} }
// Has an operation been requested?
pub(crate) fn op_requested(&self) -> bool { pub(crate) fn op_requested(&self) -> bool {
self.op_requested.is_some() self.op_requested.is_some()
} }