wwsvc-rs 4.2.0

A web client which is used to consume SoftENGINE's WEBSERVICES, a proprietary API for their software WEBWARE.
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

/// Pagination cursor, denoted by a cursor ID.
///
/// In order to create a cursor, simply call `Cursor::new()`.
/// This will set the cursor ID to "CREATE".
///
/// Once you send a request containing the cursor, the WEBWARE server returns a new cursor ID.
/// If there are no more results, the cursor ID will be "CLOSED".
#[derive(Clone, Debug)]
pub struct Cursor {
    /// The cursor ID.
    ///
    /// Is "CREATE" if the cursor has just been created.
    /// Is "CLOSED" if there are no more results.
    pub cursor_id: String,
    /// The maximum amount of results that will be returned.
    pub max_lines: u32,
}

impl Default for Cursor {
    fn default() -> Self {
        Self {
            cursor_id: "CREATE".to_string(),
            max_lines: 500,
        }
    }
}

impl Cursor {
    /// Creates a new cursor.
    pub fn new(max_lines: u32) -> Cursor {
        Cursor {
            cursor_id: "CREATE".to_string(),
            max_lines,
        }
    }

    /// Returns whether the cursor is closed.
    pub fn closed(&self) -> bool {
        &self.cursor_id == "CLOSED"
    }

    /// Sets the cursor ID.
    pub fn set_cursor_id(&mut self, cursor_id: String) {
        self.cursor_id = cursor_id;
    }
}