Skip to main content

ClassRule

Struct ClassRule 

Source
#[non_exhaustive]
pub struct ClassRule { pub name: String, pub matcher: Matcher, pub bucket: String, pub priority: u8, pub weight: u16, }
Expand description

A matcher plus what to do with what it matches.

#[non_exhaustive] with a Default — see the module doc for why the pairing is required rather than stylistic. The default is an unnamed class that claims every unit and names no bucket, so it is always edited before use; note that a defaulted weight of zero is rejected under Discipline::WeightedRoundRobin.

In the written form name and bucket are required and the other three default, because the two that are required are the two whose defaults are wrong rather than merely empty: an unnamed class collides with the next unnamed class as ShapeError::DuplicateClassName, and a class naming no bucket at all is ShapeError::UnknownBucket against the empty string. Both are refusals about a key the author never wrote.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The class name. Unique across the profile, and the label under which this class’s statistics are reported.

§matcher: Matcher

Which units this class claims.

§bucket: String

The BucketConfig::name this class charges against. Several classes may share one bucket, which is what makes Discipline mean anything.

§priority: u8

Discipline::StrictPriority orders classes by this; higher wins.

Distinct from MoQT’s publisher_priority, which Matcher::priority keys on: this one is the scheduler’s, and it is always present.

§weight: u16

Discipline::WeightedRoundRobin shares a bucket by this. Zero is rejected under that discipline and ignored under the other two.

Trait Implementations§

Source§

impl Clone for ClassRule

Source§

fn clone(&self) -> ClassRule

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ClassRule

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ClassRule

Source§

fn default() -> ClassRule

Returns the “default value” for a type. Read more
Source§

impl Eq for ClassRule

Source§

impl PartialEq for ClassRule

Source§

fn eq(&self, other: &ClassRule) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ClassRule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more