rendy-chain 0.5.1

Rendy's node synchronization tool
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use super::{
    queue::{Queue, QueueId},
    submission::{Submission, SubmissionId},
};

/// Instances of this type contains array of `Queue`s.
/// All contained queues has identical capabilities.
#[derive(Clone, Debug)]
pub struct Family<S> {
    id: rendy_core::hal::queue::QueueFamilyId,
    queues: Vec<Queue<S>>,
}

impl<S> Family<S> {
    /// Create new empty `Family`
    pub fn new(id: rendy_core::hal::queue::QueueFamilyId) -> Self {
        Family {
            id,
            queues: Vec::default(),
        }
    }

    /// Get id of the family.
    pub fn id(&self) -> rendy_core::hal::queue::QueueFamilyId {
        self.id
    }

    /// Get reference to `Queue` instance by the id.
    ///
    /// # Panic
    ///
    /// This function will panic if requested queue isn't part of this family.
    ///
    pub fn queue(&self, qid: QueueId) -> Option<&Queue<S>> {
        assert_eq!(self.id, qid.family());
        self.queues.get(qid.index())
    }

    /// Get mutable reference to `Queue` instance by the id.
    ///
    /// # Panic
    ///
    /// This function will panic if requested queue isn't part of this family.
    ///
    pub fn queue_mut(&mut self, qid: QueueId) -> Option<&mut Queue<S>> {
        assert_eq!(self.id, qid.family());
        self.queues.get_mut(qid.index())
    }

    /// Get mutable reference to `Queue` instance by the id.
    /// This function will grow queues array if index is out of bounds.
    ///
    /// # Panic
    ///
    /// This function will panic if requested queue isn't part of this family.
    ///
    pub fn ensure_queue(&mut self, qid: QueueId) -> &mut Queue<S> {
        assert_eq!(self.id, qid.family());
        let len = self.queues.len();
        self.queues
            .extend((len..qid.index() + 1).map(|i| Queue::new(QueueId::new(qid.family(), i))));
        &mut self.queues[qid.index()]
    }

    /// Get reference to `Submission<S>` instance by id.
    ///
    /// # Panic
    ///
    /// This function will panic if requested submission isn't part of this family.
    ///
    pub fn submission(&self, sid: SubmissionId) -> Option<&Submission<S>> {
        assert_eq!(self.id, sid.family());
        self.queue(sid.queue())
            .and_then(|queue| queue.submission(sid))
    }

    /// Get mutable reference to `Submission<S>` instance by id.
    ///
    /// # Panic
    ///
    /// This function will panic if requested submission isn't part of this family.
    ///
    pub fn submission_mut(&mut self, sid: SubmissionId) -> Option<&mut Submission<S>> {
        assert_eq!(self.id, sid.family());
        self.queue_mut(sid.queue())
            .and_then(|queue| queue.submission_mut(sid))
    }

    /// Iterate over queues.
    pub fn iter(&self) -> impl Iterator<Item = &Queue<S>> {
        self.queues.iter()
    }

    /// Iterate over queues.
    pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Queue<S>> {
        self.queues.iter_mut()
    }

    /// The number of queues in this schedule.
    pub fn queue_count(&self) -> usize {
        self.queues.len()
    }
}