Struct gaia_ccsds_c2a::ccsds::tc::transfer_frame::PrimaryHeader

source · 
#[repr(C)]
pub struct PrimaryHeader { /* private fields */ }

Implementations§

source§

impl PrimaryHeader

source

pub const fn new() -> Self

Returns an instance with zero initialized data.

source§

impl PrimaryHeader

source

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

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; 5]) -> Self

Converts the given bytes directly into the bitfield struct.

source§

impl PrimaryHeader

source

pub fn version_number(&self) -> <B2 as Specifier>::InOut

Returns the value of version_number.

source

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

Returns the value of version_number.

#Errors

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

source

pub fn with_version_number(self, new_val: <B2 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for version_number.

source

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

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

#Errors

If the given value is out of bounds for version_number.

source

pub fn set_version_number(&mut self, new_val: <B2 as Specifier>::InOut)

Sets the value of version_number to the given value.

#Panics

If the given value is out of bounds for version_number.

source

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

Sets the value of version_number to the given value.

#Errors

If the given value is out of bounds for version_number.

source

pub fn bypass_flag(&self) -> <bool as Specifier>::InOut

Returns the value of bypass_flag.

source

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

Returns the value of bypass_flag.

#Errors

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

source

pub fn with_bypass_flag(self, new_val: <bool as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for bypass_flag.

source

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

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

#Errors

If the given value is out of bounds for bypass_flag.

source

pub fn set_bypass_flag(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of bypass_flag to the given value.

#Panics

If the given value is out of bounds for bypass_flag.

source

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

Sets the value of bypass_flag to the given value.

#Errors

If the given value is out of bounds for bypass_flag.

source

pub fn control_command_flag(&self) -> <bool as Specifier>::InOut

Returns the value of control_command_flag.

source

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

Returns the value of control_command_flag.

#Errors

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

source

pub fn with_control_command_flag( self, new_val: <bool as Specifier>::InOut ) -> Self

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

#Panics

If the given value is out of bounds for control_command_flag.

source

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

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

#Errors

If the given value is out of bounds for control_command_flag.

source

pub fn set_control_command_flag(&mut self, new_val: <bool as Specifier>::InOut)

Sets the value of control_command_flag to the given value.

#Panics

If the given value is out of bounds for control_command_flag.

source

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

Sets the value of control_command_flag to the given value.

#Errors

If the given value is out of bounds for control_command_flag.

source

pub fn scid(&self) -> <B10 as Specifier>::InOut

Returns the value of scid.

source

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

Returns the value of scid.

#Errors

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

source

pub fn with_scid(self, new_val: <B10 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for scid.

source

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

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

#Errors

If the given value is out of bounds for scid.

source

pub fn set_scid(&mut self, new_val: <B10 as Specifier>::InOut)

Sets the value of scid to the given value.

#Panics

If the given value is out of bounds for scid.

source

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

Sets the value of scid to the given value.

#Errors

If the given value is out of bounds for scid.

source

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

Returns the value of vcid.

source

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

Returns the value of vcid.

#Errors

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

source

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

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

#Panics

If the given value is out of bounds for vcid.

source

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

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

#Errors

If the given value is out of bounds for vcid.

source

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

Sets the value of vcid to the given value.

#Panics

If the given value is out of bounds for vcid.

source

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

Sets the value of vcid to the given value.

#Errors

If the given value is out of bounds for vcid.

source

pub fn frame_length_raw(&self) -> <B10 as Specifier>::InOut

Returns the value of frame_length_raw.

source

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

Returns the value of frame_length_raw.

#Errors

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

source

pub fn with_frame_length_raw(self, new_val: <B10 as Specifier>::InOut) -> Self

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

#Panics

If the given value is out of bounds for frame_length_raw.

source

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

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

#Errors

If the given value is out of bounds for frame_length_raw.

source

pub fn set_frame_length_raw(&mut self, new_val: <B10 as Specifier>::InOut)

Sets the value of frame_length_raw to the given value.

#Panics

If the given value is out of bounds for frame_length_raw.

source

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

Sets the value of frame_length_raw to the given value.

#Errors

If the given value is out of bounds for frame_length_raw.

source

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

Returns the value of frame_sequence_number.

source

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

Returns the value of frame_sequence_number.

#Errors

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

source

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

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

#Panics

If the given value is out of bounds for frame_sequence_number.

source

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

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

#Errors

If the given value is out of bounds for frame_sequence_number.

source

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

Sets the value of frame_sequence_number to the given value.

#Panics

If the given value is out of bounds for frame_sequence_number.

source

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

Sets the value of frame_sequence_number to the given value.

#Errors

If the given value is out of bounds for frame_sequence_number.

source§

impl PrimaryHeader

source

pub const SIZE: usize = 5usize

source

pub fn frame_length_in_bytes(&self) -> usize

source

pub fn set_frame_length_in_bytes(&mut self, frame_length_in_bytes: usize)

Trait Implementations§

source§

impl AsBytes for PrimaryHeader
where [u8; 5]: AsBytes, HasPadding<PrimaryHeader, { _ }>: ShouldBe<false>,

§

fn as_bytes(&self) -> &[u8] ⓘ

Gets the bytes of this value. Read more
§

fn as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: FromBytes,

Gets the bytes of this value mutably. Read more
§

fn write_to<B>(&self, bytes: B) -> Option<()>
where B: ByteSliceMut,

Writes a copy of self to bytes. Read more
§

fn write_to_prefix<B>(&self, bytes: B) -> Option<()>
where B: ByteSliceMut,

Writes a copy of self to the prefix of bytes. Read more
§

fn write_to_suffix<B>(&self, bytes: B) -> Option<()>
where B: ByteSliceMut,

Writes a copy of self to the suffix of bytes. Read more
source§

impl CheckTotalSizeMultipleOf8 for PrimaryHeader

§

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

source§

impl Clone for PrimaryHeader

source§

fn clone(&self) -> PrimaryHeader

Returns a copy 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 PrimaryHeader

source§

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

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

impl Default for PrimaryHeader

source§

fn default() -> PrimaryHeader

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

impl FromBytes for PrimaryHeader
where [u8; 5]: FromBytes,

§

fn read_from<B>(bytes: B) -> Option<Self>
where B: ByteSlice, Self: Sized,

Reads a copy of Self from bytes. Read more
§

fn read_from_prefix<B>(bytes: B) -> Option<Self>
where B: ByteSlice, Self: Sized,

Reads a copy of Self from the prefix of bytes. Read more
§

fn read_from_suffix<B>(bytes: B) -> Option<Self>
where B: ByteSlice, Self: Sized,

Reads a copy of Self from the suffix of bytes. Read more
§

fn new_zeroed() -> Self
where Self: Sized,

Creates an instance of Self from zeroed bytes.
source§

impl Unaligned for PrimaryHeader
where [u8; 5]: Unaligned,

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
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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.

§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

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

§

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
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

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

§

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.