Struct SanitizedMediaTrackConstraint

pub struct SanitizedMediaTrackConstraint(/* private fields */);

A single non-empty constraint value for a MediaStreamTrack object.

Invariant

The wrapped ResolvedMediaTrackConstraint MUST not be empty.

To enforce this invariant the only way to create an instance of this type is by calling constraint.to_sanitized()/constraint.into_sanitized() on an instance of ResolvedMediaTrackConstraint, which returns None if self is empty.

Further more self.0 MUST NOT be exposed mutably, as otherwise it could become empty via mutation.

Implementations

impl SanitizedMediaTrackConstraint

pub fn into_inner(self) -> ResolvedMediaTrackConstraint

Consumes self returning its inner resolved constraint.

Methods from Deref<Target = ResolvedMediaTrackConstraint>

pub fn is_required(&self) -> bool

Returns true if self is required, otherwise false.

pub fn is_empty(&self) -> bool

Returns true if self is empty, otherwise false.

pub fn to_required_only(&self) -> Self

Returns a corresponding constraint containing only required values.

pub fn to_sanitized(&self) -> Option<SanitizedMediaTrackConstraint>

Returns a corresponding sanitized constraint if self is non-empty, otherwise None.

Trait Implementations

impl Clone for SanitizedMediaTrackConstraint

fn clone(&self) -> SanitizedMediaTrackConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SanitizedMediaTrackConstraint

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

Formats the value using the given formatter.

impl Deref for SanitizedMediaTrackConstraint

type Target = ResolvedMediaTrackConstraint

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl PartialEq for SanitizedMediaTrackConstraint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SanitizedMediaTrackConstraint