pub struct IsActionCam(/* private fields */);Expand description
Represents a bitfield.
Implementations§
Source§impl IsActionCam
impl IsActionCam
Sourcepub const IS_ACTION_CAMERA_BITS: u32 = 1u32
pub const IS_ACTION_CAMERA_BITS: u32 = 1u32
The number of bits is_action_camera occupies in the bitfield.
Sourcepub const IS_ACTION_CAMERA_OFFSET: u32 = 0u32
pub const IS_ACTION_CAMERA_OFFSET: u32 = 0u32
The bit offset of is_action_camera in the bitfield.
Sourcepub const fn new_without_defaults() -> Self
pub const fn new_without_defaults() -> Self
Creates a new bitfield instance without respecting default values.
Sourcepub const fn from_bits_with_defaults(bits: u32) -> Self
pub const fn from_bits_with_defaults(bits: u32) -> Self
Creates a new bitfield instance from the given bits while respecting defaults.
Sourcepub const fn from_le_bits(bits: u32) -> Self
pub const fn from_le_bits(bits: u32) -> Self
Creates a new bitfield instance from the given little-endian bits.
Sourcepub const fn from_le_bits_with_defaults(bits: u32) -> Self
pub const fn from_le_bits_with_defaults(bits: u32) -> Self
Creates a new bitfield instance from the given little-endian bits while respecting defaults.
Sourcepub const fn from_be_bits(bits: u32) -> Self
pub const fn from_be_bits(bits: u32) -> Self
Creates a new bitfield instance from the given big-endian bits.
Sourcepub const fn from_be_bits_with_defaults(bits: u32) -> Self
pub const fn from_be_bits_with_defaults(bits: u32) -> Self
Creates a new bitfield instance from the given big-endian bits while respecting defaults.
Sourcepub const fn into_le_bits(self) -> u32
pub const fn into_le_bits(self) -> u32
Returns the bits of the bitfield in little-endian order.
Sourcepub const fn into_be_bits(self) -> u32
pub const fn into_be_bits(self) -> u32
Returns the bits of the bitfield in big-endian order.
Sourcepub const fn is_action_camera(&self) -> bool
pub const fn is_action_camera(&self) -> bool
Returns bit 0.
Sourcepub const fn set_is_action_camera(&mut self, bits: bool)
pub const fn set_is_action_camera(&mut self, bits: bool)
Sets bit 0.
Sourcepub const fn checked_set_is_action_camera(
&mut self,
bits: bool,
) -> Result<(), &'static str>
pub const fn checked_set_is_action_camera( &mut self, bits: bool, ) -> Result<(), &'static str>
Sets bit 0.
Sourcepub const fn write_bits(&mut self, bits: u32)
pub const fn write_bits(&mut self, bits: u32)
Writes bits to the bitfield.
Sourcepub const fn write_bits_with_defaults(&mut self, bits: u32)
pub const fn write_bits_with_defaults(&mut self, bits: u32)
Writes bits to the bitfield while setting defaults.
Sourcepub const fn write_le_bits(&mut self, bits: u32)
pub const fn write_le_bits(&mut self, bits: u32)
Writes little-endian bits to the bitfield.
Sourcepub const fn write_le_bits_with_defaults(&mut self, bits: u32)
pub const fn write_le_bits_with_defaults(&mut self, bits: u32)
Writes little-endian bits to the bitfield while setting defaults.
Sourcepub const fn write_be_bits(&mut self, bits: u32)
pub const fn write_be_bits(&mut self, bits: u32)
Writes big-endian bits to the bitfield.
Sourcepub const fn write_be_bits_with_defaults(&mut self, bits: u32)
pub const fn write_be_bits_with_defaults(&mut self, bits: u32)
Writes big-endian bits to the bitfield while setting defaults.
Sourcepub const fn write_defaults(&mut self)
pub const fn write_defaults(&mut self)
Writes the bitfield defaults.
Sourcepub const fn checked_set_bit(
&mut self,
offset: u32,
bit: bool,
) -> Result<(), &'static str>
pub const fn checked_set_bit( &mut self, offset: u32, bit: bool, ) -> Result<(), &'static str>
Sets a bit in the bitfield. Returns an error if the offset is outside the bitfield range.
Sourcepub const fn set_bits_range(&mut self, offset: u32, length: u32, value: u32)
pub const fn set_bits_range(&mut self, offset: u32, length: u32, value: u32)
Sets bits in the bitfield starting from the offset to the length with the provided value.
Sourcepub const fn checked_set_bits_range(
&mut self,
offset: u32,
length: u32,
value: u32,
) -> Result<(), &'static str>
pub const fn checked_set_bits_range( &mut self, offset: u32, length: u32, value: u32, ) -> Result<(), &'static str>
Sets bits in the bitfield starting from the offset to the length with the provided value. Returns an error if the offset and length is outside the bitfield range, if the value is too large for the length, or if any bit in the range is non-writable.
Sourcepub const fn checked_get_bit(&self, offset: u32) -> Result<bool, &'static str>
pub const fn checked_get_bit(&self, offset: u32) -> Result<bool, &'static str>
Returns a bit from the bitfield. Returns an error if the offset is outside the bitfield range.
Sourcepub const fn get_bits_range(&self, offset: u32, length: u32) -> u32
pub const fn get_bits_range(&self, offset: u32, length: u32) -> u32
Returns bits from the bitfield.
Sourcepub const fn checked_get_bits_range(
&self,
offset: u32,
length: u32,
) -> Result<u32, &'static str>
pub const fn checked_get_bits_range( &self, offset: u32, length: u32, ) -> Result<u32, &'static str>
Returns bits from the bitfield starting from the offset to the length. Returns an error if the offset and length is outside the bitfield range or if any bit in the range is non-readable.
Sourcepub const fn clear_bits(&mut self)
pub const fn clear_bits(&mut self)
Clears all bits in the bitfield.
Sourcepub const fn clear_bits_with_defaults(&mut self)
pub const fn clear_bits_with_defaults(&mut self)
Clears all bits in the bitfield and set field defaults.
Sourcepub const fn clear_is_action_camera(&mut self)
pub const fn clear_is_action_camera(&mut self)
Clears bit 0.
Sourcepub const fn invert_bits(&mut self)
pub const fn invert_bits(&mut self)
Inverts all writable bits in the bitfield.
Sourcepub const fn invert_is_action_camera(&mut self)
pub const fn invert_is_action_camera(&mut self)
Inverts bit 0.
Sourcepub const fn is_action_camera_inverted(&self) -> bool
pub const fn is_action_camera_inverted(&self) -> bool
Inverts bit 0.
Trait Implementations§
Source§impl Clone for IsActionCam
impl Clone for IsActionCam
Source§fn clone(&self) -> IsActionCam
fn clone(&self) -> IsActionCam
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for IsActionCam
impl Debug for IsActionCam
Source§impl Default for IsActionCam
impl Default for IsActionCam
Source§fn default() -> IsActionCam
fn default() -> IsActionCam
Source§impl<'de> Deserialize<'de> for IsActionCam
impl<'de> Deserialize<'de> for IsActionCam
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl From<IsActionCam> for u32
impl From<IsActionCam> for u32
Source§fn from(val: IsActionCam) -> Self
fn from(val: IsActionCam) -> Self
Source§impl From<u32> for IsActionCam
impl From<u32> for IsActionCam
Source§impl PartialEq for IsActionCam
impl PartialEq for IsActionCam
Source§fn eq(&self, other: &IsActionCam) -> bool
fn eq(&self, other: &IsActionCam) -> bool
self and other values to be equal, and is used by ==.