Struct BackgroundControlPage

Source
pub struct BackgroundControlPage { /* private fields */ }

Implementations§

Source§

impl BackgroundControlPage

Source

pub const fn new() -> Self

Returns an instance with zero initialized data.

Source§

impl BackgroundControlPage

Source

pub const fn into_bytes(self) -> [u8; 16]

Returns the underlying bits.

§Layout

The returned byte array is layed out in the same way as described here.

Source

pub const fn from_bytes(bytes: [u8; 16]) -> Self

Converts the given bytes directly into the bitfield struct.

Source§

impl BackgroundControlPage

Source

pub fn parameters_saveable(&self) -> <B1 as Specifier>::InOut

Returns the value of parameters_saveable.

Source

pub fn parameters_saveable_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of parameters_saveable.

#Errors

If the returned value contains an invalid bit pattern for parameters_saveable.

Source

pub fn with_parameters_saveable(self, new_val: <B1 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of parameters_saveable set to the given value.

#Panics

If the given value is out of bounds for parameters_saveable.

Source

pub fn with_parameters_saveable_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of parameters_saveable set to the given value.

#Errors

If the given value is out of bounds for parameters_saveable.

Source

pub fn set_parameters_saveable(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of parameters_saveable to the given value.

#Panics

If the given value is out of bounds for parameters_saveable.

Source

pub fn set_parameters_saveable_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of parameters_saveable to the given value.

#Errors

If the given value is out of bounds for parameters_saveable.

Source

pub fn subpage_format(&self) -> <B1 as Specifier>::InOut

Returns the value of subpage_format.

Source

pub fn subpage_format_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of subpage_format.

#Errors

If the returned value contains an invalid bit pattern for subpage_format.

Source

pub fn with_subpage_format(self, new_val: <B1 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of subpage_format set to the given value.

#Panics

If the given value is out of bounds for subpage_format.

Source

pub fn with_subpage_format_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of subpage_format set to the given value.

#Errors

If the given value is out of bounds for subpage_format.

Source

pub fn set_subpage_format(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of subpage_format to the given value.

#Panics

If the given value is out of bounds for subpage_format.

Source

pub fn set_subpage_format_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of subpage_format to the given value.

#Errors

If the given value is out of bounds for subpage_format.

Source

pub fn page_code(&self) -> <B6 as Specifier>::InOut

Returns the value of page_code.

Source

pub fn page_code_or_err( &self, ) -> Result<<B6 as Specifier>::InOut, InvalidBitPattern<<B6 as Specifier>::Bytes>>

Returns the value of page_code.

#Errors

If the returned value contains an invalid bit pattern for page_code.

Source

pub fn with_page_code(self, new_val: <B6 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of page_code set to the given value.

#Panics

If the given value is out of bounds for page_code.

Source

pub fn with_page_code_checked( self, new_val: <B6 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of page_code set to the given value.

#Errors

If the given value is out of bounds for page_code.

Source

pub fn set_page_code(&mut self, new_val: <B6 as Specifier>::InOut)

Sets the value of page_code to the given value.

#Panics

If the given value is out of bounds for page_code.

Source

pub fn set_page_code_checked( &mut self, new_val: <B6 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of page_code to the given value.

#Errors

If the given value is out of bounds for page_code.

Source

pub fn subpage_code(&self) -> <B8 as Specifier>::InOut

Returns the value of subpage_code.

Source

pub fn subpage_code_or_err( &self, ) -> Result<<B8 as Specifier>::InOut, InvalidBitPattern<<B8 as Specifier>::Bytes>>

Returns the value of subpage_code.

#Errors

If the returned value contains an invalid bit pattern for subpage_code.

Source

pub fn with_subpage_code(self, new_val: <B8 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of subpage_code set to the given value.

#Panics

If the given value is out of bounds for subpage_code.

Source

pub fn with_subpage_code_checked( self, new_val: <B8 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of subpage_code set to the given value.

#Errors

If the given value is out of bounds for subpage_code.

Source

pub fn set_subpage_code(&mut self, new_val: <B8 as Specifier>::InOut)

Sets the value of subpage_code to the given value.

#Panics

If the given value is out of bounds for subpage_code.

Source

pub fn set_subpage_code_checked( &mut self, new_val: <B8 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of subpage_code to the given value.

#Errors

If the given value is out of bounds for subpage_code.

Source

pub fn page_length(&self) -> <B16 as Specifier>::InOut

Returns the value of page_length.

Source

pub fn page_length_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of page_length.

#Errors

If the returned value contains an invalid bit pattern for page_length.

Source

pub fn with_page_length(self, new_val: <B16 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of page_length set to the given value.

#Panics

If the given value is out of bounds for page_length.

Source

pub fn with_page_length_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of page_length set to the given value.

#Errors

If the given value is out of bounds for page_length.

Source

pub fn set_page_length(&mut self, new_val: <B16 as Specifier>::InOut)

Sets the value of page_length to the given value.

#Panics

If the given value is out of bounds for page_length.

Source

pub fn set_page_length_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of page_length to the given value.

#Errors

If the given value is out of bounds for page_length.

Source

pub fn suspend_on_log_full(&self) -> <B1 as Specifier>::InOut

Returns the value of suspend_on_log_full.

Source

pub fn suspend_on_log_full_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of suspend_on_log_full.

#Errors

If the returned value contains an invalid bit pattern for suspend_on_log_full.

Source

pub fn with_suspend_on_log_full(self, new_val: <B1 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of suspend_on_log_full set to the given value.

#Panics

If the given value is out of bounds for suspend_on_log_full.

Source

pub fn with_suspend_on_log_full_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of suspend_on_log_full set to the given value.

#Errors

If the given value is out of bounds for suspend_on_log_full.

Source

pub fn set_suspend_on_log_full(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of suspend_on_log_full to the given value.

#Panics

If the given value is out of bounds for suspend_on_log_full.

Source

pub fn set_suspend_on_log_full_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of suspend_on_log_full to the given value.

#Errors

If the given value is out of bounds for suspend_on_log_full.

Source

pub fn log_only_when_intervention_required(&self) -> <B1 as Specifier>::InOut

Returns the value of log_only_when_intervention_required.

Source

pub fn log_only_when_intervention_required_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of log_only_when_intervention_required.

#Errors

If the returned value contains an invalid bit pattern for log_only_when_intervention_required.

Source

pub fn with_log_only_when_intervention_required( self, new_val: <B1 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of log_only_when_intervention_required set to the given value.

#Panics

If the given value is out of bounds for log_only_when_intervention_required.

Source

pub fn with_log_only_when_intervention_required_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of log_only_when_intervention_required set to the given value.

#Errors

If the given value is out of bounds for log_only_when_intervention_required.

Source

pub fn set_log_only_when_intervention_required( &mut self, new_val: <B1 as Specifier>::InOut, )

Sets the value of log_only_when_intervention_required to the given value.

#Panics

If the given value is out of bounds for log_only_when_intervention_required.

Source

pub fn set_log_only_when_intervention_required_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of log_only_when_intervention_required to the given value.

#Errors

If the given value is out of bounds for log_only_when_intervention_required.

Source

pub fn enable_background_medium_scan(&self) -> <B1 as Specifier>::InOut

Returns the value of enable_background_medium_scan.

Source

pub fn enable_background_medium_scan_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of enable_background_medium_scan.

#Errors

If the returned value contains an invalid bit pattern for enable_background_medium_scan.

Source

pub fn with_enable_background_medium_scan( self, new_val: <B1 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of enable_background_medium_scan set to the given value.

#Panics

If the given value is out of bounds for enable_background_medium_scan.

Source

pub fn with_enable_background_medium_scan_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of enable_background_medium_scan set to the given value.

#Errors

If the given value is out of bounds for enable_background_medium_scan.

Source

pub fn set_enable_background_medium_scan( &mut self, new_val: <B1 as Specifier>::InOut, )

Sets the value of enable_background_medium_scan to the given value.

#Panics

If the given value is out of bounds for enable_background_medium_scan.

Source

pub fn set_enable_background_medium_scan_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of enable_background_medium_scan to the given value.

#Errors

If the given value is out of bounds for enable_background_medium_scan.

Source

pub fn enable_pre_scan(&self) -> <B1 as Specifier>::InOut

Returns the value of enable_pre_scan.

Source

pub fn enable_pre_scan_or_err( &self, ) -> Result<<B1 as Specifier>::InOut, InvalidBitPattern<<B1 as Specifier>::Bytes>>

Returns the value of enable_pre_scan.

#Errors

If the returned value contains an invalid bit pattern for enable_pre_scan.

Source

pub fn with_enable_pre_scan(self, new_val: <B1 as Specifier>::InOut) -> Self

Returns a copy of the bitfield with the value of enable_pre_scan set to the given value.

#Panics

If the given value is out of bounds for enable_pre_scan.

Source

pub fn with_enable_pre_scan_checked( self, new_val: <B1 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of enable_pre_scan set to the given value.

#Errors

If the given value is out of bounds for enable_pre_scan.

Source

pub fn set_enable_pre_scan(&mut self, new_val: <B1 as Specifier>::InOut)

Sets the value of enable_pre_scan to the given value.

#Panics

If the given value is out of bounds for enable_pre_scan.

Source

pub fn set_enable_pre_scan_checked( &mut self, new_val: <B1 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of enable_pre_scan to the given value.

#Errors

If the given value is out of bounds for enable_pre_scan.

Source

pub fn background_medium_scan_interval_time(&self) -> <B16 as Specifier>::InOut

Returns the value of background_medium_scan_interval_time.

Source

pub fn background_medium_scan_interval_time_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of background_medium_scan_interval_time.

#Errors

If the returned value contains an invalid bit pattern for background_medium_scan_interval_time.

Source

pub fn with_background_medium_scan_interval_time( self, new_val: <B16 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of background_medium_scan_interval_time set to the given value.

#Panics

If the given value is out of bounds for background_medium_scan_interval_time.

Source

pub fn with_background_medium_scan_interval_time_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of background_medium_scan_interval_time set to the given value.

#Errors

If the given value is out of bounds for background_medium_scan_interval_time.

Source

pub fn set_background_medium_scan_interval_time( &mut self, new_val: <B16 as Specifier>::InOut, )

Sets the value of background_medium_scan_interval_time to the given value.

#Panics

If the given value is out of bounds for background_medium_scan_interval_time.

Source

pub fn set_background_medium_scan_interval_time_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of background_medium_scan_interval_time to the given value.

#Errors

If the given value is out of bounds for background_medium_scan_interval_time.

Source

pub fn background_pre_scan_time_limit(&self) -> <B16 as Specifier>::InOut

Returns the value of background_pre_scan_time_limit.

Source

pub fn background_pre_scan_time_limit_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of background_pre_scan_time_limit.

#Errors

If the returned value contains an invalid bit pattern for background_pre_scan_time_limit.

Source

pub fn with_background_pre_scan_time_limit( self, new_val: <B16 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of background_pre_scan_time_limit set to the given value.

#Panics

If the given value is out of bounds for background_pre_scan_time_limit.

Source

pub fn with_background_pre_scan_time_limit_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of background_pre_scan_time_limit set to the given value.

#Errors

If the given value is out of bounds for background_pre_scan_time_limit.

Source

pub fn set_background_pre_scan_time_limit( &mut self, new_val: <B16 as Specifier>::InOut, )

Sets the value of background_pre_scan_time_limit to the given value.

#Panics

If the given value is out of bounds for background_pre_scan_time_limit.

Source

pub fn set_background_pre_scan_time_limit_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of background_pre_scan_time_limit to the given value.

#Errors

If the given value is out of bounds for background_pre_scan_time_limit.

Source

pub fn minimum_idle_time_before_background_scan( &self, ) -> <B16 as Specifier>::InOut

Returns the value of minimum_idle_time_before_background_scan.

Source

pub fn minimum_idle_time_before_background_scan_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of minimum_idle_time_before_background_scan.

#Errors

If the returned value contains an invalid bit pattern for minimum_idle_time_before_background_scan.

Source

pub fn with_minimum_idle_time_before_background_scan( self, new_val: <B16 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of minimum_idle_time_before_background_scan set to the given value.

#Panics

If the given value is out of bounds for minimum_idle_time_before_background_scan.

Source

pub fn with_minimum_idle_time_before_background_scan_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of minimum_idle_time_before_background_scan set to the given value.

#Errors

If the given value is out of bounds for minimum_idle_time_before_background_scan.

Source

pub fn set_minimum_idle_time_before_background_scan( &mut self, new_val: <B16 as Specifier>::InOut, )

Sets the value of minimum_idle_time_before_background_scan to the given value.

#Panics

If the given value is out of bounds for minimum_idle_time_before_background_scan.

Source

pub fn set_minimum_idle_time_before_background_scan_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of minimum_idle_time_before_background_scan to the given value.

#Errors

If the given value is out of bounds for minimum_idle_time_before_background_scan.

Source

pub fn maximum_time_to_suspend_background_scan( &self, ) -> <B16 as Specifier>::InOut

Returns the value of maximum_time_to_suspend_background_scan.

Source

pub fn maximum_time_to_suspend_background_scan_or_err( &self, ) -> Result<<B16 as Specifier>::InOut, InvalidBitPattern<<B16 as Specifier>::Bytes>>

Returns the value of maximum_time_to_suspend_background_scan.

#Errors

If the returned value contains an invalid bit pattern for maximum_time_to_suspend_background_scan.

Source

pub fn with_maximum_time_to_suspend_background_scan( self, new_val: <B16 as Specifier>::InOut, ) -> Self

Returns a copy of the bitfield with the value of maximum_time_to_suspend_background_scan set to the given value.

#Panics

If the given value is out of bounds for maximum_time_to_suspend_background_scan.

Source

pub fn with_maximum_time_to_suspend_background_scan_checked( self, new_val: <B16 as Specifier>::InOut, ) -> Result<Self, OutOfBounds>

Returns a copy of the bitfield with the value of maximum_time_to_suspend_background_scan set to the given value.

#Errors

If the given value is out of bounds for maximum_time_to_suspend_background_scan.

Source

pub fn set_maximum_time_to_suspend_background_scan( &mut self, new_val: <B16 as Specifier>::InOut, )

Sets the value of maximum_time_to_suspend_background_scan to the given value.

#Panics

If the given value is out of bounds for maximum_time_to_suspend_background_scan.

Source

pub fn set_maximum_time_to_suspend_background_scan_checked( &mut self, new_val: <B16 as Specifier>::InOut, ) -> Result<(), OutOfBounds>

Sets the value of maximum_time_to_suspend_background_scan to the given value.

#Errors

If the given value is out of bounds for maximum_time_to_suspend_background_scan.

Trait Implementations§

Source§

impl CheckTotalSizeMultipleOf8 for BackgroundControlPage

Source§

type Size = TotalSize<[(); 0]>

Source§

impl Clone for BackgroundControlPage

Source§

fn clone(&self) -> BackgroundControlPage

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackgroundControlPage

Source§

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

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

impl ModePage for BackgroundControlPage

Source§

fn new() -> Self

Source§

fn from_bytes(bytes: &[u8]) -> (Self, &[u8])

Source§

fn to_bytes(&self) -> Vec<u8>

Source§

impl Copy for BackgroundControlPage

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, 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 = Infallible

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.