wireshift-core 0.1.1

Core typed operations, buffers, and backend traits for wireshift
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Operations representing cancellation requests over previous instances.
use crate::error::Result;
use crate::op::{CompletionPayload, Op, OpDescriptor};

/// Internal operation used by the backend for request cancellation.
///
/// ```rust
/// use wireshift::ops::Cancel;
///
/// let cancel = Cancel::new(9);
/// assert_eq!(cancel.target(), 9);
/// ```
#[derive(Clone, Copy, Debug)]
pub struct Cancel {
    target: u64,
}

impl Cancel {
    /// Creates a cancel request targeting an existing request id.
    #[must_use]
    pub fn new(target: u64) -> Self {
        Self { target }
    }

    /// Returns the targeted request id.
    #[must_use]
    pub fn target(self) -> u64 {
        self.target
    }
}

impl Op for Cancel {
    type Output = ();

    fn name(&self) -> &'static str {
        "cancel"
    }

    fn into_descriptor(self) -> Result<OpDescriptor> {
        Ok(OpDescriptor::Cancel {
            target: self.target,
        })
    }

    fn map_completion(payload: CompletionPayload) -> Result<Self::Output> {
        match payload {
            CompletionPayload::Unit => Ok(()),
            other => Err(crate::error::Error::completion(
                format!("cancel received unexpected completion payload: {other:?}"),
                "ensure the backend routes cancel completions as unit payloads",
            )),
        }
    }
}