Struct rendy_chain::Family

pub struct Family<S> { /* fields omitted */ }

Instances of this type contains array of Queues. All contained queues has identical capabilities.

Methods

impl<S> Family<S>

pub fn new(id: QueueFamilyId) -> Self

Create new empty Family

pub fn id(&self) -> QueueFamilyId

Get id of the family.

pub fn queue(&self, qid: QueueId) -> Option<&Queue<S>>

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_mut(&mut self, qid: QueueId) -> Option<&mut Queue<S>>

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 ensure_queue(&mut self, qid: QueueId) -> &mut Queue<S>

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 submission(&self, sid: SubmissionId) -> Option<&Submission<S>>

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_mut(
    &mut self,
    sid: SubmissionId
) -> Option<&mut Submission<S>>

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 iter(&self) -> impl Iterator<Item = &Queue<S>>

Iterate over queues.

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut Queue<S>>

Iterate over queues.

pub fn queue_count(&self) -> usize

The number of queues in this schedule.

Trait Implementations

impl<S: Clone> Clone for Family<S>

fn clone(&self) -> Family<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for Family<S>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.