Enum Transform

#[repr(u8)]
pub enum Transform {
    Max = 1,
    Min = 2,
}

Possible transforms for a policy target.

A transform is an operation that is applied to a policy property when the fuchsia.settings.Audio API is used. Multiple transforms of the same time can be active for a single property.

Variants

Max = 1

Limits the maximum value of an audio stream to a certain level.

Max volume limits are transparent to clients of fuchsia.settings.Audio. Clients will always be able to set the volume to 1.0 (max) to prevent user confusion about not being able to set the volume to max. The internal volume, which is communicated to AudioCore to set the true volume level, will always be clamped to the specified maximum.

Externally, the volume percentage will always be a percentage of the max allowed by policy. For example, if the max limit is set to 0.8, a client setting the volume to 1.0 translates to 0.8 internally. An external volume of 0.5 would be scaled to 0.4 internally.

If a min volume limit is present, the minimum external volume will be the min volume limit divided by the max volume limit. For example, if the max volume limit is 0.8 and the min volume limit is 0.2, the lowest possible external volume is 0.25, since 0.2 is 25% of 0.8. The min range is not transparent to clients to prevent the confusion of volume being at 0% but still being able to hear audio.

Min = 2

Limits the minimum value of an audio stream to a certain level.

If the volume is below the specified minimum level when the policy is added, it will automatically be raised to the specified minimum. Calls to set the volume below the minimum level will not fail, but the actual volume will stay above the specified minimum level.

Note that the minimum volume limit is a limit on the internal “true” volume level. If a maximum volume policy is set, the minimum that clients of fuchsia.settings.Audio will see is higher. See the documentation of the MAX volume transform for more information.

Implementations

impl Transform

pub fn from_primitive(prim: u8) -> Option<Self>

pub const fn into_primitive(self) -> u8

pub fn is_unknown(&self) -> bool

👎Deprecated: Strict enums should not use is_unknown

Trait Implementations

impl Clone for Transform

fn clone(&self) -> Transform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transform

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<Transform, D> for Transform

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl<D: ResourceDialect> Encode<Transform, D> for Transform

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, _depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl Hash for Transform

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Transform

fn cmp(&self, other: &Transform) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Transform

fn eq(&self, other: &Transform) -> 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 PartialOrd for Transform

fn partial_cmp(&self, other: &Transform) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TypeMarker for Transform

type Owned = Transform

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for Transform

type Borrowed<'a> = Transform

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Copy for Transform

impl Eq for Transform

impl StructuralPartialEq for Transform